Usage

To avoid intensive traffic utilization and save your time you can use command line admin to achieve following tasks:

  • Install using defaults
  • Install from backup
  • Backup
  • Cleanup

Some example commands:

MySQL (requires to place the MySQL JDBC driver into webapps/openmeetings/WEB-INF/lib before running the command):

./admin.sh -i -v -tz Europe/Berlin -email your.email@gmail.com -group webbase -user admin --smtp-server localhost \
	--db-type mysql --db-name openmeetings_db --email-auth-user noreply@webbase-design.de --password 123qweasd \
	--system-email-address noreply@webbase-design.de --db-user root --db-host localhost --email-auth-pass 123qweasd
			

Derby (Not recommended for production environment):

./admin.sh -i -v -tz Europe/Berlin -email seba.wagner@gmail.com -group webbase -user admin --smtp-server localhost \
	--email-auth-user noreply@webbase-design.de --password 123qweasd --system-email-address noreply@webbase-design.de --email-auth-pass 123qweasd
			

Command reference

 -v,--verbose                        verbose error messages
--------------------------------------------------------------------------------------------------
 -h,--help                           prints this message
--------------------------------------------------------------------------------------------------
 -b,--backup                         Backups OM
   -file <arg>                       (optional) file used for backup/restore/install
      --exclude-files                (optional) should backup exclude files [default: include]
--------------------------------------------------------------------------------------------------
 -r,--restore                        Restores OM
   -file <arg>                       file used for backup/restore/install
--------------------------------------------------------------------------------------------------
 -l,--LDAP                           Import LDAP users into DB
   -d,--domain-id <arg>              LDAP domain Id
      --print-only                   (optional) Print users found instead of importing
--------------------------------------------------------------------------------------------------
 -i,--install                        Fill DB table, and make OM usable
   -tz <arg>                         Default server time zone, and time zone for the selected user
                                     (mutually exclusive with 'file')
   -group <arg>                      The name of the default user group (mutually exclusive with
                                     'file')
   -email <arg>                      Email of the default user (mutually exclusive with 'file')
   -user <arg>                       Login name of the default user, minimum 4 characters (mutually
                                     exclusive with 'file')
   -file <arg>                       file used for backup/restore/install
      --password <arg>               (optional) Password of the default user, minimum 4 characters
                                     (will be prompted if not set)
      --system-email-address <arg>   (optional) System e-mail address [default:
                                     noreply@openmeetings.apache.org]
      --smtp-server <arg>            (optional) SMTP server for outgoing e-mails [default:
                                     localhost]
      --smtp-port <arg>              (optional) SMTP server for outgoing e-mails [default: 25]
      --email-auth-user <arg>        (optional) Email auth username (anonymous connection will be
                                     used if not set)
      --email-auth-pass <arg>        (optional) Email auth password (anonymous connection will be
                                     used if not set)
      --email-use-tls                (optional) Is secure e-mail connection [default: no]
      --skip-default-rooms           (optional) Do not create default rooms [created by default]
      --disable-frontend-register    (optional) Do not allow front end register [allowed by default]
      --db-type <arg>                (optional) The type of the DB to be used
      --db-host <arg>                (optional) DNS name or IP address of database
      --db-port <arg>                (optional) Database port
      --db-name <arg>                (optional) The name of Openmeetings database
      --db-user <arg>                (optional) User with write access to the DB specified
      --db-pass <arg>                (optional) Password of the user with write access to the DB
                                     specified
      --drop                         (optional) Drop database before installation
      --force                        (optional) Install without checking the existence of old data
                                     in the database.
--------------------------------------------------------------------------------------------------
 -f,--files                          File operations - statictics/cleanup
      --cleanup                      (optional) Should intermediate files be clean up
--------------------------------------------------------------------------------------------------