From 1d95edc45586cf65dec49a0b5b434aa98bcea3ca Mon Sep 17 00:00:00 2001 From: cupcakearmy Date: Tue, 26 Jul 2022 15:49:06 +0200 Subject: [PATCH] readme --- README.md | 34 +++++----------------------------- examples/traefik/README.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 41 insertions(+), 29 deletions(-) create mode 100644 examples/traefik/README.md diff --git a/README.md b/README.md index 6a25942..9bcdde1 100644 --- a/README.md +++ b/README.md @@ -93,39 +93,15 @@ See the [examples/nginx](https://github.com/cupcakearmy/cryptgeon/tree/main/exam ### Traefik 2 -Assumptions: +See the [examples/traefik](https://github.com/cupcakearmy/cryptgeon/tree/main/examples/traefik) folder. -- External proxy docker network `proxy` -- A certificate resolver `le` -- A https entrypoint `secure` -- Domain name `example.org` +### Scratch -```yaml -version: '3.8' +See the [examples/scratch](https://github.com/cupcakearmy/cryptgeon/tree/main/examples/scratch) folder. There you'll find a guide how to setup a server and install cryptgeon from scratch. -networks: - proxy: - external: true +### Synology -services: - redis: - image: redis:7-alpine - restart: unless-stopped - - app: - image: cupcakearmy/cryptgeon:latest - restart: unless-stopped - depends_on: - - redis - networks: - - default - - proxy - labels: - - traefik.enable=true - - traefik.http.routers.cryptgeon.rule=Host(`example.org`) - - traefik.http.routers.cryptgeon.entrypoints=secure - - traefik.http.routers.cryptgeon.tls.certresolver=le -``` +There is a [guide](https://mariushosting.com/how-to-install-cryptgeon-on-your-synology-nas/) you can follow. ## Development diff --git a/examples/traefik/README.md b/examples/traefik/README.md new file mode 100644 index 0000000..6fd5dbc --- /dev/null +++ b/examples/traefik/README.md @@ -0,0 +1,36 @@ +# Install Cryptgeon with Traefik + +Assumptions: + +- Traefik 2 installed. +- External proxy docker network `proxy`. +- A certificate resolver `le`. +- A https entrypoint `secure`. +- Domain name `example.org`. + +```yaml +version: '3.8' + +networks: + proxy: + external: true + +services: + redis: + image: redis:7-alpine + restart: unless-stopped + + app: + image: cupcakearmy/cryptgeon:latest + restart: unless-stopped + depends_on: + - redis + networks: + - default + - proxy + labels: + - traefik.enable=true + - traefik.http.routers.cryptgeon.rule=Host(`example.org`) + - traefik.http.routers.cryptgeon.entrypoints=secure + - traefik.http.routers.cryptgeon.tls.certresolver=le +```