feat: Add docker demo setup

.goreleaser.yml

@@ -1,5 +1,6 @@
 env:
   - GO111MODULE=on
+  - CGO_ENABLED=0
   - RELEASE_BUILDS=dist/listmonk_darwin_amd64/listmonk dist/listmonk_linux_amd64/listmonk dist/listmonk_windows_amd64//listmonk.exe
 
 before:
@@ -34,8 +35,8 @@ dockers:
     binaries:
     - listmonk
     image_templates:
-    - "knadh/listmonk:latest"
+    - "listmonk/listmonk:latest"
-    - "knadh/listmonk:{{ .Tag }}"
+    - "listmonk/listmonk:{{ .Tag }}"
     dockerfile: Dockerfile
     extra_files:
     - config.toml.sample

Dockerfile

@@ -1,6 +1,6 @@
 FROM alpine:latest AS deploy
 RUN apk --no-cache add ca-certificates
-COPY listmonk /
+WORKDIR /listmonk
-COPY config.toml.sample  /etc/listmonk/config.toml
+COPY listmonk .
-VOLUME ["/etc/listmonk"]
+COPY config.toml.sample config.toml
-CMD ["./listmonk", "--config", "/etc/listmonk/config.toml"]  
+CMD ["./listmonk"]

INSTALL.md

@@ -3,3 +3,20 @@
 - Run `./listmonk --new-config` to generate a sample `config.toml` and add your configuration (SMTP and Postgres DB credentials primarily).
 - `./listmonk --install` to setup the DB.
 - Visit `http://localhost:9000`.
+
+## 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` to setup the DB.
+- Visit `http://localhost:9000`.
+
+### Demo Setup
+
+`docker-compose.yml` includes a demo setup to quickly try out `listmonk`. It spins up PostgreSQL and listmonk app containers without any persistent data.
+
+- Run `docker-compose up -d demo-db demo-app`.
+- Visit `http://localhost:9000`.
+
+_NOTE_: This setup will delete the data once you kill and remove the containers. This setup is NOT intended for production use.

README.md

@@ -19,9 +19,11 @@ listmonk is a standalone, self-hosted, newsletter and mailing list manager. It i
 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.
+- `docker-compose run --rm app ./listmonk --install` to setup the DB.
 - Visit `http://localhost:9000`.
 
+Alternatively, to run a demo of listmonk, you can quickly spin up a container `docker-compose up -d demo-db demo-app`. NOTE: This doesn't persist Postgres data after you stop and remove the container, this setup is intended only for demo. _DO NOT_ use the demo setup in production.
+
 ### Help and docs
 
 [Help and documentation](https://listmonk.app/docs) (work in progress).

config.toml.sample

@@ -46,10 +46,10 @@ max_send_errors = 1000
 
 # Database.
 [db]
-host = "localhost"
+host = "demo-db"
 port = 5432
 user = "listmonk"
-password = ""
+password = "listmonk"
 database = "listmonk"
 ssl_mode = "disable"
 

docker-compose.yml

@@ -4,15 +4,18 @@
 
 version: "3.7"
 
-services:
+x-app-defaults: &app-defaults
-  db:
+  restart: unless-stopped
+  image: listmonk/listmonk:latest
+  ports:
+    - "9000:9000"
+  networks:
+    - listmonk
+
+x-db-defaults: &db-defaults
     image: postgres:11
     ports:
-      - "5432:5432"
+      - "9432:5432"
-    volumes:
-      - type: volume
-        source: listmonk-data
-        target: /var/lib/postgresql/data
     networks:
       - listmonk
     environment:
@@ -21,19 +24,27 @@ services:
       - POSTGRES_DB=listmonk
     restart: unless-stopped
 
+services:
+  db:
+    <<: *db-defaults
+    volumes:
+      - type: volume
+        source: listmonk-data
+        target: /var/lib/postgresql/data
+
   app:
-    restart: unless-stopped
+    <<: *app-defaults
     depends_on:
       - db
-    image: knadh/listmonk:latest
+
-    volumes:
+  demo-db:
-      - type: bind
+    <<: *db-defaults
-        source: ./config.toml
+
-        target: /etc/listmonk/config.toml
+  demo-app:
-    ports:
+    <<: *app-defaults
-      - "9000:9000"
+    command: [sh, -c, "yes | ./listmonk --install && ./listmonk"]
-    networks:
+    depends_on: 
-      - listmonk
+      - demo-db
 
 networks:
   listmonk: