From 1a49826b85b45be0d438a1f52fd06f829d97bea6 Mon Sep 17 00:00:00 2001 From: Daniel Hiller Date: Tue, 24 Oct 2023 13:17:49 +0200 Subject: [PATCH] docs: adjust filenames to match the docs --- README.md | 7 +++--- docker-compose-db.yml | 16 +++++++++++++ docker-compose-dev.yml | 54 +++++++++++++++++++++++++++++++++++++++--- 3 files changed, 70 insertions(+), 7 deletions(-) create mode 100644 docker-compose-db.yml diff --git a/README.md b/README.md index 3c7feb97..e3b54ab0 100644 --- a/README.md +++ b/README.md @@ -20,10 +20,9 @@ ## How to deploy Planka -There are 2 types of installation: -- [Without Docker](https://docs.planka.cloud/docs/installl-planka/Debian%20&%20Ubuntu) ([for Windows](https://docs.planka.cloud/docs/installl-planka/Windows)) -- [Dockerized](https://docs.planka.cloud/docs/installl-planka/Docker%20Compose) -- [Automated installation](https://github.com/plankanban/planka-installer) +There are many ways to install Planka + +[Check them out](https://docs.planka.cloud/docs/intro) For configuration, please see the [configuration section](https://docs.planka.cloud/docs/category/configuration). diff --git a/docker-compose-db.yml b/docker-compose-db.yml new file mode 100644 index 00000000..9bc6bc58 --- /dev/null +++ b/docker-compose-db.yml @@ -0,0 +1,16 @@ +version: '3' + +services: + postgres: + image: postgres:alpine + restart: unless-stopped + volumes: + - db-data:/var/lib/postgresql/data + ports: + - 5432:5432 + environment: + - POSTGRES_DB=planka + - POSTGRES_HOST_AUTH_METHOD=trust + +volumes: + db-data: diff --git a/docker-compose-dev.yml b/docker-compose-dev.yml index 9bc6bc58..fe90dda9 100644 --- a/docker-compose-dev.yml +++ b/docker-compose-dev.yml @@ -1,16 +1,64 @@ version: '3' services: + planka: + image: ghcr.io/plankanban/planka:dev + command: > + bash -c + "for i in `seq 1 30`; do + ./start.sh && + s=$$? && break || s=$$?; + echo \"Tried $$i times. Waiting 5 seconds...\"; + sleep 5; + done; (exit $$s)" + restart: unless-stopped + volumes: + - user-avatars:/app/public/user-avatars + - project-background-images:/app/public/project-background-images + - attachments:/app/private/attachments + ports: + - 3000:1337 + environment: + - BASE_URL=http://localhost:3000 + - DATABASE_URL=postgresql://postgres@postgres/planka + - SECRET_KEY=notsecretkey + + # - TRUST_PROXY=0 + # - TOKEN_EXPIRES_IN=365 # In days + + # related: https://github.com/knex/knex/issues/2354 + # As knex does not pass query parameters from the connection string we + # have to use environment variables in order to pass the desired values, e.g. + # - PGSSLMODE= + + # Configure knex to accept SSL certificates + # - KNEX_REJECT_UNAUTHORIZED_SSL_CERTIFICATE=false + + # - DEFAULT_ADMIN_EMAIL=demo@demo.demo # Do not remove if you want to prevent this user from being edited/deleted + # - DEFAULT_ADMIN_PASSWORD=demo + # - DEFAULT_ADMIN_NAME=Demo Demo + # - DEFAULT_ADMIN_USERNAME=demo + + # - OIDC_ISSUER= + # - OIDC_CLIENT_ID= + # - OIDC_CLIENT_SECRET= + # - OIDC_SCOPES=openid email profile + # - OIDC_ADMIN_ROLES=admin + # - OIDC_ROLES_ATTRIBUTE=groups + depends_on: + - postgres + postgres: - image: postgres:alpine + image: postgres:14-alpine restart: unless-stopped volumes: - db-data:/var/lib/postgresql/data - ports: - - 5432:5432 environment: - POSTGRES_DB=planka - POSTGRES_HOST_AUTH_METHOD=trust volumes: + user-avatars: + project-background-images: + attachments: db-data: