Chapril/xmpp.chapril.org-ejabberd
25
1
Fork 0
mirror of https://github.com/processone/ejabberd.git synced 2024-11-20 16:15:59 +01:00
Code Releases Activity

Container: Raise sections levels to improve legibility in GitHub web TOC

Browse Source
This commit is contained in:
Badlop 2022-11-07 19:27:34 +01:00
parent d957404adc
commit 662d9a0ed0
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
CONTAINER.md
View File

@ -34,9 +34,9 @@ If you are using a Windows operating system, check the tutorials mentioned in
Start ejabberd
--------------
==============
### With default configuration
## With default configuration
Start ejabberd in a new container:
@ -60,7 +60,7 @@ docker restart ejabberd
```
### Start with Erlang console attached
## Start with Erlang console attached
Start ejabberd with an Erlang console attached using the `live` command:
@ -71,7 +71,7 @@ docker run --name ejabberd -it -p 5222:5222 ghcr.io/processone/ejabberd live
That uses the default configuration file and XMPP domain "localhost".
### Start with your configuration and database
## Start with your configuration and database
Pass a configuration file as a volume
and share the local directory to store database:
@ -93,9 +93,9 @@ and the volumes you mount must grant proper rights to that account.
Next steps
----------
==========
### Register the administrator account
## Register the administrator account
The default ejabberd configuration does not grant admin privileges
to any account,
@ -112,7 +112,7 @@ Then edit conf/ejabberd.yml and add the ACL as explained in
[ejabberd Docs: Administration Account](https://docs.ejabberd.im/admin/installation/#administration-account)
### Check ejabberd log files
## Check ejabberd log files
Check the content of the log files inside the container,
even if you do not put it on a shared persistent drive:
@ -122,7 +122,7 @@ docker exec -it ejabberd tail -f logs/ejabberd.log
```
### Inspect the container files
## Inspect the container files
The container uses Alpine Linux. Start a shell inside the container:
@ -131,7 +131,7 @@ docker exec -it ejabberd sh
```
### Open ejabberd debug console
## Open ejabberd debug console
Open an interactive debug Erlang console attached to a running ejabberd in a running container:
@ -140,7 +140,7 @@ docker exec -it ejabberd ejabberdctl debug
```
### CAPTCHA
## CAPTCHA
ejabberd includes two example CAPTCHA scripts.
If you want to use any of them, first install some additional required libraries:
@ -167,9 +167,9 @@ docker exec ejabberd ejabberdctl reload_config
Advanced Container Configuration
--------------------------------
================================
### Ports
## Ports
This container image exposes the ports:
@ -182,7 +182,7 @@ This container image exposes the ports:
- `5210`: Erlang connectivity when `ERL_DIST_PORT` is set, alternative to EPMD
### Volumes
## Volumes
ejabberd produces two types of data: log files and database spool files (Mnesia).
This is the kind of data you probably want to store on a persistent or local drive (at least the database).
@ -203,7 +203,7 @@ It's possible to install additional ejabberd modules using volumes,
explains how to install an additional module using docker-compose.
### Commands on start
## Commands on start
The ejabberdctl script reads the `CTL_ON_CREATE` environment variable
the first time the docker container is started,
@ -221,7 +221,7 @@ Example usage (see full example [docker-compose.yml](https://github.com/processo
```
### Clustering
## Clustering
When setting several containers to form a
[cluster of ejabberd nodes](https://docs.ejabberd.im/admin/guide/clustering/),
@ -260,7 +260,7 @@ Example using environment variables (see full example [docker-compose.yml](https
Generating a Container Image
----------------------------
============================
This container image includes ejabberd as a standalone OTP release built using Elixir.