Compare commits
6 Commits
0.1.0+1.8.
...
0.4.0+1.9.
Author | SHA1 | Date | |
---|---|---|---|
90d5d3fc18 | |||
b282386419 | |||
980cac71d8 | |||
d277bd9ac1 | |||
5343ebb076 | |||
f6827630d8 |
13
.env.sample
13
.env.sample
@ -1,26 +1,27 @@
|
|||||||
TYPE=codimd
|
TYPE=hedgedoc
|
||||||
|
|
||||||
DOMAIN=codimd.example.com
|
DOMAIN=hedgedoc.example.com
|
||||||
## Domain aliases
|
## Domain aliases
|
||||||
#EXTRA_DOMAINS=', `www.codimd.example.com`'
|
#EXTRA_DOMAINS=', `www.hedgedoc.example.com`'
|
||||||
LETS_ENCRYPT_ENV=production
|
LETS_ENCRYPT_ENV=production
|
||||||
|
|
||||||
SECRET_DB_PASSWORD_VERSION=v1
|
SECRET_DB_PASSWORD_VERSION=v1
|
||||||
|
|
||||||
COMPOSE_FILE="compose.yml"
|
COMPOSE_FILE="compose.yml"
|
||||||
|
|
||||||
# OAuth, see https://hackmd.io/@codimd/codimd-generic-oauth-2
|
# OAuth, see https://docs.hedgedoc.org/guides/auth/keycloak/
|
||||||
|
|
||||||
#COMPOSE_FILE="$COMPOSE_FILE:compose.oauth.yml"
|
#COMPOSE_FILE="$COMPOSE_FILE:compose.oauth.yml"
|
||||||
#CMD_OAUTH2_PROVIDERNAME="Keycloak"
|
#CMD_OAUTH2_PROVIDERNAME="Keycloak"
|
||||||
#CMD_OAUTH2_BASEURL="https://keycloak.example.com/realms/realmname/protocol/openid-connect/"
|
#CMD_OAUTH2_CLIENT_ID="hedgedoc"
|
||||||
#CMD_OAUTH2_CLIENT_ID="codimd"
|
|
||||||
#CMD_OAUTH2_AUTHORIZATION_URL="https://keycloak.example.com/auth/realms/realmname/protocol/openid-connect/auth"
|
#CMD_OAUTH2_AUTHORIZATION_URL="https://keycloak.example.com/auth/realms/realmname/protocol/openid-connect/auth"
|
||||||
#CMD_OAUTH2_TOKEN_URL="https://keycloak.example.com/auth/realms/realmname/protocol/openid-connect/token"
|
#CMD_OAUTH2_TOKEN_URL="https://keycloak.example.com/auth/realms/realmname/protocol/openid-connect/token"
|
||||||
#CMD_OAUTH2_USER_PROFILE_URL="https://keycloak.example.com/auth/realms/realmname/protocol/openid-connect/userinfo"
|
#CMD_OAUTH2_USER_PROFILE_URL="https://keycloak.example.com/auth/realms/realmname/protocol/openid-connect/userinfo"
|
||||||
#CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR=ocs.data.id
|
#CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR=ocs.data.id
|
||||||
#CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR=ocs.data.display-name
|
#CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR=ocs.data.display-name
|
||||||
#CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR=ocs.data.email
|
#CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR=ocs.data.email
|
||||||
|
#CMD_OAUTH2_PROVIDERNAME=Keycloak
|
||||||
|
#CMD_OAUTH2_SCOPE="openid email profile"
|
||||||
#
|
#
|
||||||
#SECRET_OAUTH_KEY_VERSION=v1
|
#SECRET_OAUTH_KEY_VERSION=v1
|
||||||
|
|
||||||
|
@ -6,13 +6,13 @@
|
|||||||
|
|
||||||
<!-- metadata -->
|
<!-- metadata -->
|
||||||
* **Category**: Apps
|
* **Category**: Apps
|
||||||
* **Status**: ❷💛
|
* **Status**: 2, beta
|
||||||
* **Image**: [`quay.io/hedgedoc/hedgedoc:1.8.2`](https://quay.io/hedgedoc/hedgedoc:1.8.2), ❶💚, upstream
|
* **Image**: [`quay.io/hedgedoc/hedgedoc:1.8.2`](https://quay.io/hedgedoc/hedgedoc:1.8.2), 4, upstream
|
||||||
* **Healthcheck**: Yes
|
* **Healthcheck**: Yes
|
||||||
* **Backups**: No
|
* **Backups**: No
|
||||||
* **Email**: No
|
* **Email**: No
|
||||||
* **Tests**: ❷💛
|
* **Tests**: 2
|
||||||
* **SSO**: ❶💚 (OAuth)
|
* **SSO**: 3 (OAuth)
|
||||||
<!-- endmetadata -->
|
<!-- endmetadata -->
|
||||||
|
|
||||||
## Basic usage
|
## Basic usage
|
||||||
|
@ -5,7 +5,6 @@ services:
|
|||||||
app:
|
app:
|
||||||
environment:
|
environment:
|
||||||
- CMD_OAUTH2_PROVIDERNAME
|
- CMD_OAUTH2_PROVIDERNAME
|
||||||
- CMD_OAUTH2_BASEURL
|
|
||||||
- CMD_OAUTH2_CLIENT_ID
|
- CMD_OAUTH2_CLIENT_ID
|
||||||
- CMD_OAUTH2_CLIENT_SECRET_FILE=/run/secrets/oauth_key
|
- CMD_OAUTH2_CLIENT_SECRET_FILE=/run/secrets/oauth_key
|
||||||
- CMD_OAUTH2_AUTHORIZATION_URL
|
- CMD_OAUTH2_AUTHORIZATION_URL
|
||||||
@ -14,6 +13,7 @@ services:
|
|||||||
- CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR
|
- CMD_OAUTH2_USER_PROFILE_USERNAME_ATTR
|
||||||
- CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR
|
- CMD_OAUTH2_USER_PROFILE_DISPLAY_NAME_ATTR
|
||||||
- CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR
|
- CMD_OAUTH2_USER_PROFILE_EMAIL_ATTR
|
||||||
|
- CMD_OAUTH2_SCOPE
|
||||||
secrets:
|
secrets:
|
||||||
- oauth_key
|
- oauth_key
|
||||||
|
|
||||||
|
12
compose.yml
12
compose.yml
@ -1,7 +1,7 @@
|
|||||||
version: "3.8"
|
version: "3.8"
|
||||||
services:
|
services:
|
||||||
app:
|
app:
|
||||||
image: quay.io/hedgedoc/hedgedoc:1.8.2
|
image: quay.io/hedgedoc/hedgedoc:1.9.3
|
||||||
environment:
|
environment:
|
||||||
- CMD_USECDN=false
|
- CMD_USECDN=false
|
||||||
- CMD_URL_ADDPORT=false
|
- CMD_URL_ADDPORT=false
|
||||||
@ -53,7 +53,7 @@ services:
|
|||||||
- "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-redirect"
|
- "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-redirect"
|
||||||
- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLForceHost=true"
|
- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLForceHost=true"
|
||||||
- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLHost=${DOMAIN}"
|
- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLHost=${DOMAIN}"
|
||||||
- coop-cloud.${STACK_NAME}.version=0.1.0+1.8.2
|
- coop-cloud.${STACK_NAME}.version=0.4.0+1.9.3
|
||||||
healthcheck:
|
healthcheck:
|
||||||
test: "nodejs -e \"http.get('http://localhost:3000', (res) => { console.log('status: ', res.statusCode); if (res.statusCode == 200) { process.exit(0); } else { process.exit(1); } });\""
|
test: "nodejs -e \"http.get('http://localhost:3000', (res) => { console.log('status: ', res.statusCode); if (res.statusCode == 200) { process.exit(0); } else { process.exit(1); } });\""
|
||||||
interval: 30s
|
interval: 30s
|
||||||
@ -61,7 +61,7 @@ services:
|
|||||||
retries: 10
|
retries: 10
|
||||||
start_period: 1m
|
start_period: 1m
|
||||||
db:
|
db:
|
||||||
image: postgres:11.12-alpine
|
image: postgres:11.16-alpine
|
||||||
environment:
|
environment:
|
||||||
- POSTGRES_USER=codimd
|
- POSTGRES_USER=codimd
|
||||||
- POSTGRES_PASSWORD_FILE=/run/secrets/db_password
|
- POSTGRES_PASSWORD_FILE=/run/secrets/db_password
|
||||||
@ -72,6 +72,12 @@ services:
|
|||||||
- db_password
|
- db_password
|
||||||
networks:
|
networks:
|
||||||
- internal
|
- internal
|
||||||
|
deploy:
|
||||||
|
labels:
|
||||||
|
backupbot.backup: "true"
|
||||||
|
backupbot.backup.pre-hook: "mkdir -p /tmp/backup/ && PGPASSWORD=$$(cat $${POSTGRES_PASSWORD_FILE}) pg_dump -U $${POSTGRES_USER} $${POSTGRES_DB} > /tmp/backup/backup.sql"
|
||||||
|
backupbot.backup.post-hook: "rm -rf /tmp/backup"
|
||||||
|
backupbot.backup.path: "/tmp/backup/"
|
||||||
volumes:
|
volumes:
|
||||||
postgres:
|
postgres:
|
||||||
codimd_uploads:
|
codimd_uploads:
|
||||||
|
Reference in New Issue
Block a user