Welcome to Shipyard’s Docker Compose Community Spotlight series! During this series, we’ll feature a new Docker Compose-enabled open source project every week, show you how to run it on Shipyard, and how to contribute. This week, we’ll be featuring listmonk by Kailash Nadh.
Listmonk
Listmonk is an open source newsletter and mailing list manager. It provides tools to simplify the process of templating and sending emails to large mailing lists, and offers informative analytics for all of your email campaigns.
You can run listmonk locally by cloning the repo, modifying its Docker Compose file, and running the docker compose up command. Below, we’ll show you how to get your own copy up and running in an ephemeral environment on Shipyard.
Listmonk Alternatives
Listmonk is designed as a high-performance, self-hosted application with everything you need for email marketing management. Popular alternatives include:
| Alternative | Platform | Pricing |
|---|---|---|
| Mailchimp | Web | Free tier |
| Campayn | Web, self-hosted | Free tier |
| Mailtrain | Self-hosted | Open source |
| Sender | Web | Free tier |
If you’re reading this and know of another alternative, please reach out to us at hello@shipyard.build – we would love to feature it!
Running Listmonk on Shipyard
Listmonk’s Docker Compose file is located in the repo’s dev directory. To make your copy of listmonk Shipyard-compatible, we’ll add a route under the frontend’s service defined in the Compose file. Create a fork of the repo and open the Docker Compose file.
front:
labels:
shipyard.route: '/'
build:
context: ../
dockerfile: dev/app.Dockerfile
All you’ll need is a shipyard.route label under the front service, then you can go forward with creating a Shipyard app based off of your own fork!
If you’d like to read more about running a Docker Compose-enabled app on Shipyard, check out our docs here.
Contributing to Listmonk
If you’re interested in getting involved, check out listmonk’s contribution guidelines. After sending in a proposal of your intended contribution(s) and getting approval, you can begin iterating on a branch. When you open a PR, you can preview your changes in an ephemeral environment on Shipyard. This allows you to test your branch to ensure everything is ready for merge.
And that’s a wrap! Thanks for checking out this week’s Docker Compose Community Spotlight! Stay tuned for next week’s featured open source app. If you’re ready to try out this app in an ephemeral environment, kick off a free Shipyard account here and go to the project’s repository here. Happy coding!
