Add separate Readme for each image.
This commit is contained in:
Abhilash Raj
114
README.md
114
README.md
@@ -11,6 +11,12 @@ run multi-container applications. This repository consists of a
|
||||
[`docker-compose.yaml`](docker-compose.yaml) file which is a set of
|
||||
configurations that can be used to deploy the [Mailman 3 Suite][4].
|
||||
|
||||
While is not _official_ way to deploy Mailman 3, I will try my best to help if
|
||||
you encounter problems.
|
||||
|
||||
For now, both `mailman-core` and `mailman-web` images are built from latest git
|
||||
branches for all the proejcts, but in future when Mailman 3.1 is released, I
|
||||
will have seperate images for latest and stable versions of the containers.
|
||||
|
||||
Dependencies
|
||||
============
|
||||
@@ -22,12 +28,49 @@ are using. You can find documentation about [how to install][5]. It is
|
||||
recomended to use these instead of the one from your package managers. After you
|
||||
have downloaded and installed docker, install docker-compose from [here][6].
|
||||
|
||||
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Most of the configuraiton is supposed to be handled through environment
|
||||
variables in the `docker-compose.yaml`.
|
||||
|
||||
### Mailman-web
|
||||
These are the settings that you MUST change before deploying:
|
||||
|
||||
- `SERVE_FROM_DOMAIN`: The domain name from which Django will be served. To be
|
||||
added to `ALLOWED_HOSTS` in django settings. Default value is not set.
|
||||
|
||||
- `HYPERKITT_API_KEY`: Hyperkitty's API Key, should be set to the same value as
|
||||
set for the mailman-core.
|
||||
|
||||
For more detauls on how to configura this image, please look at [Mailman-web's
|
||||
Readme](web/README.md)
|
||||
|
||||
### Mailman-Core
|
||||
|
||||
These are the variables that you MUST change before deploying:
|
||||
|
||||
- `HYPERKITT_API_KEY`: Hyperkitty's API Key, should be set to the same value as
|
||||
set for the mailman-core.
|
||||
|
||||
- `DATABASE_CLASS`: Default value is `mailman.database.sqlite.SQLiteDatabase`.
|
||||
|
||||
For more details on how to configure this image, please look [Mailman-core's
|
||||
Readme](core/README.md)
|
||||
|
||||
Running
|
||||
=======
|
||||
|
||||
To run the containers, simply run:
|
||||
|
||||
```bash
|
||||
$ mkdir -p /opt/mailman/core
|
||||
$ mkdir -p /opt/mailman/web
|
||||
$ git clone https://github.com/maxking/docker-mailman
|
||||
$ cd docker-mailman
|
||||
# Change some configuration variables as mentioned below.
|
||||
$ docker-compose up
|
||||
```
|
||||
|
||||
@@ -188,77 +231,6 @@ exit 0
|
||||
|
||||
Please do not forget to make the script executable (chmod +x certbot-renew.sh).
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Most of the configuraiton is supposed to be handled through environment
|
||||
variables in the `docker-compose.yaml`.
|
||||
|
||||
### Mailman-web
|
||||
These are the settings that you MUST change before deploying:
|
||||
|
||||
- `SERVE_FROM_DOMAIN`: The domain name from which Django will be served. To be
|
||||
added to `ALLOWED_HOSTS` in django settings. Default value is not set.
|
||||
|
||||
- `HYPERKITT_API_KEY`: Hyperkitty's API Key, should be set to the same value as
|
||||
set for the mailman-core.
|
||||
|
||||
These are the settings that are set to sane default and you do not need to
|
||||
change them unless you know what you want.
|
||||
|
||||
- `DATABASE_URL`: URL of the type
|
||||
`driver://user:password@hostname:port/databasename` for the django to use. If
|
||||
not set, the default is set to
|
||||
`sqlite:///opt/mailman-web-data/mailmanweb.db`. The standard
|
||||
docker-compose.yaml comes with it set to a postgres database. It is not must
|
||||
to change this if you are happy with postgresql.
|
||||
|
||||
- `MAILMAN_REST_URL`: The URL to the Mailman core's REST API server. Defaut
|
||||
value is `http://mailman-core:8001`.
|
||||
|
||||
- `MAILMAN_REST_USER`: Mailman's REST API username. Default value is `restadmin`
|
||||
|
||||
- `MAILMAN_REST_PASSWORD`: Mailman's REST API user's password. Default value is
|
||||
`restpass`
|
||||
|
||||
- `DJANGO_HOST_IP`: IP of the container from which the django will be
|
||||
served. Default value is `172.19.199.3`.
|
||||
|
||||
- `SMTP_HOST`: IP Address/hostname from which you will be sending
|
||||
emails. Default value is `172.19.199.1`, which is the address of the Host OS.
|
||||
|
||||
- `SMTP_PORT`: Port used for SMTP. Default is `25`.
|
||||
|
||||
|
||||
### Mailman-Core
|
||||
|
||||
These are the variables that you MUST change before deploying:
|
||||
|
||||
- `HYPERKITT_API_KEY`: Hyperkitty's API Key, should be set to the same value as
|
||||
set for the mailman-core.
|
||||
|
||||
- `DATABASE_CLASS`: Default value is `mailman.database.sqlite.SQLiteDatabase`.
|
||||
|
||||
These are the variables that you don't need to change if you are using a
|
||||
standard version of docker-compose.yaml from this repository.
|
||||
|
||||
- `MM_HOSTNAME`: Default value is `mailman-core`
|
||||
|
||||
- `SMTP_HOST`: IP Address/hostname from which you will be sending
|
||||
emails. Default value is `172.19.199.1`, which is the address of the Host OS.
|
||||
|
||||
- `SMTP_PORT`: Port used for SMTP. Default is `25`.
|
||||
|
||||
- `HYPERKITTY_API_URL`: Default value is `http://mailman-web:8000/hyperkitty`
|
||||
|
||||
- `DATABASE_URL`: URL of the type
|
||||
`driver://user:password@hostname:port/databasename` for the django to use. If
|
||||
not set, the default is set to
|
||||
`sqlite:///opt/mailman-web-data/mailmanweb.db`. The standard
|
||||
docker-compose.yaml comes with it set to a postgres database. It is not must
|
||||
to change this if you are happy with postgresql.
|
||||
|
||||
|
||||
LICENSE
|
||||
=======
|
||||
|
||||
|
||||
Reference in New Issue
Block a user