hangar-tech
/
listmonk
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

feat: Add docker instructions

This commit is contained in:
mr-karan 2019-07-12 07:51:48 +05:30
parent bdc837d03f
commit 3ed39a4f56
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -14,6 +14,14 @@ listmonk is a standalone, self-hosted, newsletter and mailing list manager. It i
- Visit `http://localhost:9000`. - Visit `http://localhost:9000`.
- Since there is no user auth yet, it's best to put listmonk behind a proxy like Nginx and setup basicauth on all endpoints except for the few endpoints that need to be public. Here is a [sample nginx config](https://github.com/knadh/listmonk/wiki/Production-Nginx-config) for production use. - Since there is no user auth yet, it's best to put listmonk behind a proxy like Nginx and setup basicauth on all endpoints except for the few endpoints that need to be public. Here is a [sample nginx config](https://github.com/knadh/listmonk/wiki/Production-Nginx-config) for production use.
### Running on Docker
You can checkout the [docker-compose.yml](docker-compose.yml) to get an idea of how to run `listmonk` with `PostgreSQL` together using Docker.
- `docker-compose up -d` to run all the services together.
- `docker-compose run --rm app ./listmonk --install --config /etc/listmonk/config.toml` to setup the DB.
- Visit `http://localhost:9000`.
### Help and docs ### Help and docs
[Help and documentation](https://listmonk.app/docs) (work in progress). [Help and documentation](https://listmonk.app/docs) (work in progress).