From: Badlop Date: Fri, 9 Jan 2009 14:04:56 +0000 (+0000) Subject: * doc/guide.tex: Improve explanation of backup commands X-Git-Tag: v2.0.3~10 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3e12700e1102e33e490069a6dd2d931895053344;p=ejabberd * doc/guide.tex: Improve explanation of backup commands * doc/guide.html: Likewise SVN Revision: 1789 --- diff --git a/ChangeLog b/ChangeLog index 15b862868..afc913e36 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,8 @@ 2009-01-09 Badlop + * doc/guide.tex: Improve explanation of backup commands + * doc/guide.html: Likewise + * src/web/ejabberd_web_admin.erl: New appearance of WebAdmin logo, fixed logo-fill. diff --git a/doc/guide.html b/doc/guide.html index 56fbf2e5c..7236dfab9 100644 --- a/doc/guide.html +++ b/doc/guide.html @@ -1010,6 +1010,10 @@ declarations of ACLs in the configuration file have the following syntax:
{server, <server>}
Matches any JID from server <server>. Example: 
{acl, exampleorg, {server, "example.org"}}.
+
{shared_group, <groupname>}
Matches any member of a Shared Roster Group with name <groupname> in the virtual host. Example: +
{acl, techgroupmembers, {shared_group, "techteam"}}.
+
{shared_group, <groupname>, <server>}
Matches any member of a Shared Roster Group with name <groupname> in the virtual host <server>. Example: +
{acl, techgroupmembers, {shared_group, "techteam", "example.org"}}.
{user_regexp, <regexp>}
Matches any local user with a name that matches <regexp> on local virtual hosts. Example: 
{acl, tests, {user_regexp, "^test[0-9]*$"}}.
@@ -2801,8 +2805,21 @@ The more interesting ones are:
reopen-log
Reopen the log files after they were renamed. If the old files were not renamed before calling this command, they are automatically renamed to "*-old.log". See section 7.1. -
backup, restore, install-fallback, dump, load
You can use these -commands to create and restore backups. +
backup ejabberd.backup
+Store internal Mnesia database to a binary backup file. +
restore ejabberd.backup
+Restore immediately from a binary backup file the internal Mnesia database. +This will comsume quite some memory for big servers. +
install-fallback ejabberd.backup
+The binary backup file is installed as fallback: +it will be used to restore the database at the next ejabberd start. +Similar to restore, but requires less memory. +
dump ejabberd.dump
+Dump internal Mnesia database to a text file dump. +
load ejabberd.dump
+Restore immediately from a text file dump. +This is not recommended for big databases, as it will consume much time, +memory and processor. In that case it’s preferable to use backup and install-fallback.
import-file, import-dir
These options can be used to migrate from other Jabber/XMPP servers. There exist tutorials to migrate from other software to ejabberd. diff --git a/doc/guide.tex b/doc/guide.tex index 6b3f0be59..7c0ff7fab 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -3580,8 +3580,21 @@ The more interesting ones are: \titem{reopen-log} Reopen the log files after they were renamed. If the old files were not renamed before calling this command, they are automatically renamed to \term{"*-old.log"}. See section \ref{logfiles}. -\titem {backup, restore, install-fallback, dump, load} You can use these - commands to create and restore backups. +\titem {backup ejabberd.backup} + Store internal Mnesia database to a binary backup file. +\titem {restore ejabberd.backup} + Restore immediately from a binary backup file the internal Mnesia database. + This will comsume quite some memory for big servers. +\titem {install-fallback ejabberd.backup} + The binary backup file is installed as fallback: + it will be used to restore the database at the next ejabberd start. + Similar to \term{restore}, but requires less memory. +\titem {dump ejabberd.dump} + Dump internal Mnesia database to a text file dump. +\titem {load ejabberd.dump} + Restore immediately from a text file dump. + This is not recommended for big databases, as it will consume much time, + memory and processor. In that case it's preferable to use \term{backup} and \term{install-fallback}. %%More information about backuping can %% be found in section~\ref{backup}. \titem{import-file, import-dir} \ind{migration from other software}