mirror of
https://github.com/processone/ejabberd.git
synced 2024-06-02 21:17:12 +02:00
* doc/guide.tex: Fix indentation of verbatim text
SVN Revision: 1351
This commit is contained in:
Badlop
parent
38d218c129
commit
aaae1339e1
|
|
@ -2,7 +2,8 @@
|
|||
|
||||
* doc/guide.tex: Permanent reference URL for sections (EJAB-651).
|
||||
Changes in CSS: verbatim text is indented and has grey background;
|
||||
descriptions are indented; table borders are softer.
|
||||
descriptions are indented; table borders are softer. Fix
|
||||
indentation of verbatim text.
|
||||
|
||||
2008-06-08 Badlop <badlop@process-one.net>
|
||||
|
||||
|
|
|
|||
131
doc/guide.tex
131
doc/guide.tex
|
|
@ -376,13 +376,13 @@ You can use the \term{ejabberdctl} command line administration script to start a
|
|||
|
||||
Usage example:
|
||||
\begin{verbatim}
|
||||
$ ejabberdctl start
|
||||
ejabberdctl start
|
||||
|
||||
$ ejabberdctl status
|
||||
ejabberdctl status
|
||||
Node ejabberd@localhost is started. Status: started
|
||||
ejabberd is running
|
||||
|
||||
$ ejabberdctl stop
|
||||
ejabberdctl stop
|
||||
\end{verbatim}
|
||||
Please refer to the section~\ref{ejabberdctl} for details about \term{ejabberdctl},
|
||||
and configurable options to fine tune the Erlang runtime system.
|
||||
|
|
@ -468,7 +468,7 @@ to enter the \ejabberd{} Web Admin:
|
|||
\begin{enumerate}
|
||||
\item Using \term{ejabberdctl}\ind{ejabberdctl} (see section~\ref{ejabberdctl}):
|
||||
\begin{verbatim}
|
||||
% ejabberdctl register admin1 example.org FgT5bk3
|
||||
ejabberdctl register admin1 example.org FgT5bk3
|
||||
\end{verbatim}
|
||||
\item Using a Jabber client and In-Band Registration (see section~\ref{modregister}).
|
||||
\end{enumerate}
|
||||
|
|
@ -612,10 +612,10 @@ use this syntax:
|
|||
In this example three virtual hosts have some similar modules, but there are also
|
||||
other different modules for some specific virtual hosts:
|
||||
\begin{verbatim}
|
||||
% This ejabberd server has three vhosts:
|
||||
%% This ejabberd server has three vhosts:
|
||||
{hosts, ["one.example.org", "two.example.org", "three.example.org"]}.
|
||||
|
||||
% Configuration of modules that are common to all vhosts
|
||||
%% Configuration of modules that are common to all vhosts
|
||||
{modules,
|
||||
[
|
||||
{mod_roster, []},
|
||||
|
|
@ -627,17 +627,23 @@ other different modules for some specific virtual hosts:
|
|||
{mod_version, []}
|
||||
]}.
|
||||
|
||||
% Add some modules to vhost one:
|
||||
{host_config, "one.example.org", [{{add, modules}, [
|
||||
%% Add some modules to vhost one:
|
||||
{host_config, "one.example.org",
|
||||
[{{add, modules}, [
|
||||
{mod_echo, [{host, "echo-service.one.example.org"}]}
|
||||
{mod_http_bind, []},
|
||||
{mod_logxml, []}
|
||||
]}]}.
|
||||
]
|
||||
}
|
||||
]}.
|
||||
|
||||
% Add a module just to vhost two:
|
||||
{host_config, "two.example.org", [{{add, modules}, [
|
||||
%% Add a module just to vhost two:
|
||||
{host_config, "two.example.org",
|
||||
[{{add, modules}, [
|
||||
{mod_echo, [{host, "mirror.two.example.org"}]}
|
||||
]}]}.
|
||||
]
|
||||
}
|
||||
]}.
|
||||
\end{verbatim}
|
||||
|
||||
\makesubsection{listened}{Listening Ports}
|
||||
|
|
@ -1082,10 +1088,11 @@ security issues:
|
|||
\term{epam}. By default, it is located in \verb|/var/lib/ejabberd/priv/lib/|
|
||||
directory. You have to set it root on execution in the case when your PAM module
|
||||
requires root privileges (\term{pam\_unix.so} for example). Also you have to grant access
|
||||
for \ejabberd{} to this file and remove all other permissions from it:
|
||||
for \ejabberd{} to this file and remove all other permissions from it.
|
||||
Execute with root privileges:
|
||||
\begin{verbatim}
|
||||
# chown root:ejabberd /var/lib/ejabberd/priv/bin/epam
|
||||
# chmod 4750 /var/lib/ejabberd/priv/bin/epam
|
||||
chown root:ejabberd /var/lib/ejabberd/priv/bin/epam
|
||||
chmod 4750 /var/lib/ejabberd/priv/bin/epam
|
||||
\end{verbatim}
|
||||
\item Make sure you have the latest version of PAM installed on your system.
|
||||
Some old versions of PAM modules cause memory leaks. If you are not able to use the latest
|
||||
|
|
@ -1748,14 +1755,14 @@ infos in \term{"ou=AddressBook,dc=example,dc=org"} directory. Corresponding
|
|||
authentication section should looks like this:
|
||||
|
||||
\begin{verbatim}
|
||||
%% authentication method
|
||||
%% Authentication method
|
||||
{auth_method, ldap}.
|
||||
%% DNS name of our LDAP server
|
||||
{ldap_servers, ["ldap.example.org"]}.
|
||||
%% Bind to LDAP server as "cn=Manager,dc=example,dc=org" with password "secret"
|
||||
{ldap_rootdn, "cn=Manager,dc=example,dc=org"}.
|
||||
{ldap_password, "secret"}.
|
||||
%% define the user's base
|
||||
%% Define the user's base
|
||||
{ldap_base, "ou=Users,dc=example,dc=org"}.
|
||||
%% We want to authorize users from 'shadowAccount' object class only
|
||||
{ldap_filter, "(objectClass=shadowAccount)"}.
|
||||
|
|
@ -1768,6 +1775,7 @@ Also we want users to search each other. Let's see how we can set it up:
|
|||
|
||||
\begin{verbatim}
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
{mod_vcard_ldap,
|
||||
[
|
||||
|
|
@ -1807,7 +1815,7 @@ Also we want users to search each other. Let's see how we can set it up:
|
|||
{"Birthday", "BDAY"}]}
|
||||
]},
|
||||
...
|
||||
}.
|
||||
]}.
|
||||
\end{verbatim}
|
||||
|
||||
Note that \modvcardldap{} module checks for the existence of the user before
|
||||
|
|
@ -1830,6 +1838,7 @@ configuration is shown below:
|
|||
{ldap_filter, "(memberOf=*)"}.
|
||||
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
{mod_vcard_ldap,
|
||||
[{ldap_vcard_map,
|
||||
|
|
@ -1866,7 +1875,7 @@ configuration is shown below:
|
|||
{"Email", "EMAIL"}]}
|
||||
]},
|
||||
...
|
||||
}.
|
||||
]}.
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
|
|
@ -1884,7 +1893,8 @@ Examples:
|
|||
options are specified between the square brackets:
|
||||
\begin{verbatim}
|
||||
{modules,
|
||||
[{mod_echo, []}
|
||||
[
|
||||
{mod_echo, []}
|
||||
]}.
|
||||
\end{verbatim}
|
||||
\item In the second example the modules \modecho{}, \modtime{}, and
|
||||
|
|
@ -1892,7 +1902,8 @@ Examples:
|
|||
all entries end with a comma:
|
||||
\begin{verbatim}
|
||||
{modules,
|
||||
[{mod_echo, []},
|
||||
[
|
||||
{mod_echo, []},
|
||||
{mod_time, []},
|
||||
{mod_version, []}
|
||||
]}.
|
||||
|
|
@ -2003,7 +2014,7 @@ these queries. Possible values are:
|
|||
of IQ queries of a namespace with this discipline. In addition, the processing
|
||||
of this queue is done in parallel with that of other packets. This discipline
|
||||
is most recommended.
|
||||
\titem{\{queues, N\}}: N separate queues are created to process the
|
||||
\titem{\{queues, N\}} N separate queues are created to process the
|
||||
queries. The queries are thus process in parallel, but in a
|
||||
controlled way.
|
||||
\titem{parallel} For every packet with this discipline a separate Erlang process
|
||||
|
|
@ -2115,10 +2126,10 @@ Examples:
|
|||
{acl, direction, {user, "big_boss", "example.org"}}.
|
||||
{acl, direction, {user, "assistant", "example.org"}}.
|
||||
{acl, admins, {user, "admin", "example.org"}}.
|
||||
...
|
||||
|
||||
{access, announce, [{allow, admins},
|
||||
{allow, direction}]}.
|
||||
...
|
||||
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
|
|
@ -2269,10 +2280,10 @@ Examples:
|
|||
{acl, paying_customers, {user, "customer1", "example.net"}}.
|
||||
{acl, paying_customers, {user, "customer2", "example.com"}}.
|
||||
{acl, paying_customers, {user, "customer3", "example.org"}}.
|
||||
...
|
||||
|
||||
{access, paying_customers, [{allow, paying_customers},
|
||||
{deny, all}]}.
|
||||
...
|
||||
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
|
|
@ -2433,9 +2444,9 @@ Examples:
|
|||
feature is disabled.
|
||||
\begin{verbatim}
|
||||
{acl, admins, {user, "admin", "example.org"}}.
|
||||
...
|
||||
|
||||
{access, muc_admins, [{allow, admins}]}.
|
||||
...
|
||||
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
|
|
@ -2461,13 +2472,13 @@ Examples:
|
|||
{acl, paying_customers, {user, "customer2", "example.com"}}.
|
||||
{acl, paying_customers, {user, "customer3", "example.org"}}.
|
||||
{acl, admins, {user, "admin", "example.org"}}.
|
||||
...
|
||||
|
||||
{access, muc_admins, [{allow, admins},
|
||||
{deny, all}]}.
|
||||
{access, muc_access, [{allow, paying_customers},
|
||||
{allow, admins},
|
||||
{deny, all}]}.
|
||||
...
|
||||
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
|
|
@ -2484,7 +2495,6 @@ change its presence more than once every 4 seconds. No ACLs are
|
|||
defined, but some user restriction could be added as well:
|
||||
|
||||
\begin{verbatim}
|
||||
...
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
|
|
@ -2502,7 +2512,8 @@ defined, but some user restriction could be added as well:
|
|||
...
|
||||
{mod_muc, [{access, muc_access},
|
||||
{access_create, muc_admins},
|
||||
{default_room_options, [
|
||||
{default_room_options,
|
||||
[
|
||||
{allow_change_subj, false},
|
||||
{allow_query_users, true},
|
||||
{allow_private_messages, true},
|
||||
|
|
@ -2592,7 +2603,7 @@ Examples:
|
|||
\verb|<a href="http://www.jabber.ru">Jabber.ru</a>|.
|
||||
\begin{verbatim}
|
||||
{access, muc, [{allow, all}]}.
|
||||
...
|
||||
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
|
|
@ -2617,10 +2628,10 @@ Examples:
|
|||
\begin{verbatim}
|
||||
{acl, admins, {user, "admin1", "example.org"}}.
|
||||
{acl, admins, {user, "admin2", "example.net"}}.
|
||||
...
|
||||
|
||||
{access, muc_log, [{allow, admins},
|
||||
{deny, all}]}.
|
||||
...
|
||||
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
|
|
@ -2747,11 +2758,11 @@ Examples:
|
|||
\begin{verbatim}
|
||||
{acl, proxy_users, {server, "example.org"}}.
|
||||
{access, proxy65_access, [{allow, proxy_users}, {deny, all}]}.
|
||||
...
|
||||
|
||||
{acl, admin, {user, "admin", "example.org"}}.
|
||||
{shaper, normal, {maxrate, 10240}}. %% 10 Kbytes/sec
|
||||
{access, proxy65_shaper, [{none, admin}, {normal, all}]}.
|
||||
...
|
||||
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
|
|
@ -2847,12 +2858,12 @@ Examples:
|
|||
\begin{verbatim}
|
||||
{acl, shortname, {user_glob, "?"}}.
|
||||
{acl, shortname, {user_glob, "??"}}.
|
||||
% The same using regexp:
|
||||
%{acl, shortname, {user_regexp, "^..?$"}}.
|
||||
...
|
||||
%% The same using regexp:
|
||||
%%{acl, shortname, {user_regexp, "^..?$"}}.
|
||||
|
||||
{access, register, [{deny, shortname},
|
||||
{allow, all}]}.
|
||||
...
|
||||
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
|
|
@ -2871,20 +2882,21 @@ Examples:
|
|||
{modules,
|
||||
[
|
||||
...
|
||||
% {mod_register, [{access, register}]},
|
||||
%% {mod_register, [{access, register}]},
|
||||
...
|
||||
]}.
|
||||
\end{verbatim}
|
||||
\item Define the welcome message and three registration watchers.
|
||||
\item Define the welcome message and two registration watchers.
|
||||
Also define a registration timeout of one hour:
|
||||
\begin{verbatim}
|
||||
{registration_timeout, 3600}.
|
||||
{modules,
|
||||
[
|
||||
...
|
||||
{mod_register, [
|
||||
{welcome_message, {"Welcome!", "Welcome to this Jabber server. For information about Jabber visit http://www.jabber.org"}},
|
||||
{registration_watchers, ["admin1@example.org", "admin2@example.org", "boss@example.net"]}
|
||||
{mod_register,
|
||||
[
|
||||
{welcome_message, {"Welcome!", "Welcome to this Jabber server. Check http://www.jabber.org"}},
|
||||
{registration_watchers, ["admin1@example.org", "boss@example.net"]}
|
||||
]},
|
||||
...
|
||||
]}.
|
||||
|
|
@ -3547,36 +3559,35 @@ Examples:
|
|||
\verb|http://example.org:5280/admin/server/example.com/| you can only
|
||||
administer the virtual host \jid{example.com}.
|
||||
\begin{verbatim}
|
||||
...
|
||||
{acl, admins, {user, "admin", "example.net"}}.
|
||||
{host_config, "example.com", [{acl, admins, {user, "admin", "example.com"}}]}.
|
||||
{access, configure, [{allow, admins}]}.
|
||||
...
|
||||
|
||||
{hosts, ["example.org"]}.
|
||||
...
|
||||
|
||||
{listen,
|
||||
[...
|
||||
[
|
||||
...
|
||||
{5280, ejabberd_http, [http_poll, web_admin]},
|
||||
...
|
||||
]
|
||||
}.
|
||||
]}.
|
||||
\end{verbatim}
|
||||
\item For security reasons, you can serve the Web Admin on a secured
|
||||
connection, on a port differing from the HTTP Polling interface, and bind it
|
||||
to the internal LAN IP. The Web Admin will be accessible by pointing your
|
||||
web browser to \verb|https://192.168.1.1:5280/admin/|:
|
||||
\begin{verbatim}
|
||||
...
|
||||
|
||||
{hosts, ["example.org"]}.
|
||||
...
|
||||
|
||||
{listen,
|
||||
[...
|
||||
[
|
||||
...
|
||||
{5270, ejabberd_http, [http_poll]},
|
||||
{5280, ejabberd_http, [web_admin, {ip, {192, 168, 1, 1}},
|
||||
tls, {certfile, "/usr/local/etc/server.pem"}]},
|
||||
...
|
||||
]
|
||||
}.
|
||||
]}.
|
||||
\end{verbatim}
|
||||
\end{itemize}
|
||||
|
||||
|
|
@ -3908,6 +3919,12 @@ Example configuration:
|
|||
{watchdog_admins, ["admin2@localhost", "admin2@example.org"]}.
|
||||
\end{verbatim}
|
||||
|
||||
To remove watchdog admins, remove them in the option.
|
||||
To remove all watchdog admins, set the option with an empty list:
|
||||
\begin{verbatim}
|
||||
{watchdog_admins, []}.
|
||||
\end{verbatim}
|
||||
|
||||
|
||||
\makesection{logfiles}{Log Files}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user