| <?xml version="1.0" encoding="UTF-8"?> | |
| <!-- | |
| Licensed under the Apache License, Version 2.0 (the "License"); | |
| you may not use this file except in compliance with the License. | |
| You may obtain a copy of the License at | |
| http://www.apache.org/licenses/LICENSE-2.0 | |
| Unless required by applicable law or agreed to in writing, software | |
| distributed under the License is distributed on an "AS IS" BASIS, | |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| See the License for the specific language governing permissions and | |
| limitations under the License. | |
| --> | |
| <document xmlns="http://maven.apache.org/XDOC/2.0" | |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | |
| xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> | |
| <properties> | |
| <title>Command line admin</title> | |
| <author email="dev@openmeetings.apache.org">Apache OpenMeetings Team</author> | |
| </properties> | |
| <body> | |
| <section name="Usage"> | |
| <p>To avoid intensive traffic utilization and save your time you can | |
| use command line admin to achieve following tasks:</p> | |
| <ul> | |
| <li>Install using defaults</li> | |
| <li>Install from backup</li> | |
| <li>Backup</li> | |
| <li>Cleanup</li> | |
| </ul> | |
| <p>Some example commands:</p> | |
| <p>MySQL (requires to place the MySQL JDBC driver into webapps/openmeetings/WEB-INF/lib before running the command):</p> | |
| <source>./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 | |
| </source> | |
| <p>Derby (Not recommended for production environment):</p> | |
| <source>./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 | |
| </source> | |
| </section> | |
| <section name="Command reference"> | |
| <source><![CDATA[ | |
| -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 | |
| -------------------------------------------------------------------------------------------------- | |
| ]]></source> | |
| </section> | |
| </body> | |
| </document> |