c7a962bfd0
Bumps [url-parse](https://github.com/unshiftio/url-parse) from 1.5.1 to 1.5.3. - [Release notes](https://github.com/unshiftio/url-parse/releases) - [Commits](https://github.com/unshiftio/url-parse/compare/1.5.1...1.5.3) --- updated-dependencies: - dependency-name: url-parse dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> |
||
|---|---|---|
| .github | ||
| cmd | ||
| frontend | ||
| i18n | ||
| internal | ||
| models | ||
| scripts | ||
| static | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| .goreleaser.yml | ||
| config-demo.toml | ||
| config.toml.sample | ||
| docker-compose.yml | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| install-demo.sh | ||
| install-prod.sh | ||
| LICENSE | ||
| listmonk@.service | ||
| Makefile | ||
| queries.sql | ||
| README.md | ||
| schema.sql | ||
| stats.sql | ||
| TODO.md | ||
| VERSION | ||
listmonk is a standalone, self-hosted, newsletter and mailing list manager. It is fast, feature-rich, and packed into a single binary. It uses a PostgreSQL database as its data store.
Visit listmonk.app
Installation
Docker
The latest image is available on DockerHub at listmonk/listmonk:latest. Use the sample docker-compose.yml to run listmonk and Postgres DB with docker-compose as follows:
Demo
mkdir listmonk-demo
sh -c "$(curl -fsSL https://raw.githubusercontent.com/knadh/listmonk/master/install-demo.sh)"
The demo does not persist Postgres after the containers are removed. DO NOT use this demo setup in production.
Production
Easy Docker install
This setup is recommended if you want to quickly setup listmonk in production.
mkdir listmonk
sh -c "$(curl -fsSL https://raw.githubusercontent.com/knadh/listmonk/master/install-prod.sh)"
The above shell script performs the following actions:
- Downloads
docker-compose.ymland generates aconfig.toml. - Runs a Postgres container and installs the database schema.
- Runs the
listmonkcontainer.
NOTE: It's recommended to examine the contents of the shell script, before running in your environment.
Manual Docker install
The following workflow is recommended to setup listmonk manually using docker-compose. You are encouraged to customise the contents of docker-compose.yml to your needs. The overall setup looks like:
docker-compose up dbto run the Postgres DB.docker-compose run --rm app ./listmonk --installto setup the DB (or--upgradeto upgrade an existing DB).- Copy
config.toml.sampleto your directory and make the following changes:app.address=>0.0.0.0:9000(Port forwarding on Docker will work only if the app is advertising on all interfaces.)db.host=>listmonk_db(Container Name of the DB container)
- Run
docker-compose up appand visithttp://localhost:9000.
More information on docs.
Binary
- Download the latest release and extract the listmonk binary.
./listmonk --new-configto generate config.toml. Then, edit the file../listmonk --installto setup the Postgres DB (or--upgradeto upgrade an existing DB. Upgrades are idempotent and running them multiple times have no side effects).- Run
./listmonkand visithttp://localhost:9000.
Heroku
Using the Nginx buildpack can be used to deploy listmonk on Heroku and use Nginx as a proxy to setup basicauth. This one-click Heroku deploy button provides an automated default deployment.
Please note that configuration options must be set using environment configuration variables.
Developers
listmonk is a free and open source software licensed under AGPLv3. If you are interested in contributing, refer to the developer setup. The backend is written in Go and the frontend is Vue with Buefy for UI.
License
listmonk is licensed under the AGPL v3 license.