diff --git a/README.md b/README.md index cd47dec..85c9faf 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,53 @@ See ```CHANGELOG.md``` ## Installation -### Docker-compose method +### Docker-compose method (production) + +```console +version: "3.8" + +services: + + teddit: + container_name: teddit + image: teddit/teddit:latest + environment: + - DOMAIN=teddit.net + - USE_HELMET=true + - USE_HELMET_HSTS=true + - TRUST_PROXY=true + - REDIS_HOST=teddit-redis + ports: + - "127.0.0.1:8080:8080" + networks: + - teddit_net + healthcheck: + test: ["CMD", "wget" ,"--no-verbose", "--tries=1", "--spider", "http://localhost:8080/about"] + interval: 1m + timeout: 3s + depends_on: + - teddit-redis + + teddit-redis: + container_name: teddit-redis + image: redis:6.2.5-alpine + command: redis-server + environment: + - REDIS_REPLICATION_MODE=master + networks: + - teddit_net + +networks: + teddit_net: +``` + +Note: This compose is made for a true "production" setup, and is made to be used to have teddit behind a reverse proxy, if you don't want that and prefer to directly access teddit via its port: + +- Change `ports: - "127.0.0.1:8080:8080"` to `ports: - "8080:8080"` +- Remove `DOMAIN=teddit.net`, `USE_HELMET=true`, `USE_HELMET_HSTS=true`, `TRUST_PROXY=true` + + +### Docker-compose method (development) ```console git clone https://codeberg.org/teddit/teddit diff --git a/docker-compose.yml b/docker-compose.yml index e16f226..93abedf 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,21 +1,16 @@ +# This docker-compose file is made for development purpose and build from source, if you want to use teddit in production, the README contains a production-ready docker-compose setup. + version: "3.8" services: - redis: - image: redis:6.2.5-alpine - command: redis-server - environment: - - REDIS_REPLICATION_MODE=master - ports: - - "6379:6379" - networks: - - teddit_net - web: + + teddit: + container_name: teddit build: . environment: - - REDIS_HOST=redis + - REDIS_HOST=teddit-redis ports: - - 8080:8080 + - "8080:8080" networks: - teddit_net healthcheck: @@ -23,6 +18,16 @@ services: interval: 1m timeout: 3s depends_on: - - redis + - teddit-redis + + teddit-redis: + container_name: teddit-redis + image: redis:6.2.5-alpine + command: redis-server + environment: + - REDIS_REPLICATION_MODE=master + networks: + - teddit_net + networks: teddit_net: