diff --git a/README.md b/README.md index fb12050..b93042f 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,21 @@ 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`. +- `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. + +- `DATABASE_TYPE`: It's value can be one of `sqlite`, `postgres` or `mysql` as + these are the only three database types that Mailman 3 supports. It's defualt + value is set to `sqlite` along with the default database class and default + database url above. + +- `DATABASE_CLASS`: Default value is + `mailman.database.sqlite.SQLiteDatabase`. The values for this can be found in + the mailman's documentation [here][11]. For more details on how to configure this image, please look [Mailman-core's Readme](core/README.md) @@ -247,3 +261,4 @@ more details. [8]: http://exim.org/ [9]: https://letsencrypt.org/ [10]: https://certbot.eff.org/ +[11]: https://mailman.readthedocs.io/en/latest/src/mailman/docs/database.html diff --git a/core/README.md b/core/README.md index ba2c25e..447250e 100644 --- a/core/README.md +++ b/core/README.md @@ -18,7 +18,22 @@ 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`. +- `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. + +- `DATABASE_TYPE`: It's value can be one of `sqlite`, `postgres` or `mysql` as + these are the only three database types that Mailman 3 supports. It's defualt + value is set to `sqlite` along with the default database class and default + database url above. + +- `DATABASE_CLASS`: Default value is + `mailman.database.sqlite.SQLiteDatabase`. The values for this can be found in + the mailman's documentation [here][11]. + 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. @@ -32,13 +47,6 @@ standard version of docker-compose.yaml from this repository. - `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. - Running Mailman-Core ====================