From cb3d517b6993d51c4807230434eaa65511190233 Mon Sep 17 00:00:00 2001 From: Nicolas Meienberger Date: Wed, 1 Mar 2023 20:58:44 +0100 Subject: [PATCH] chore(hedgedoc): refactor config --- apps/hedgedoc/config.json | 9 +++++---- apps/hedgedoc/docker-compose.yml | 13 ++++++++----- apps/hedgedoc/metadata/description.md | 18 ++++-------------- 3 files changed, 17 insertions(+), 23 deletions(-) diff --git a/apps/hedgedoc/config.json b/apps/hedgedoc/config.json index 0b4f240d..4a004316 100644 --- a/apps/hedgedoc/config.json +++ b/apps/hedgedoc/config.json @@ -13,20 +13,21 @@ "website": "https://hedgedoc.org/", "author": "https://github.com/hedgedoc", "source": "https://github.com/hedgedoc/hedgedoc", + "supported_architectures": ["amd64"], "form_fields": [ { "type": "random", - "label": "DB_PASSWORD", + "label": "HEDGEDOC_DB_PASSWORD", "min": 32, - "env_variable": "DB_PASSWORD" + "env_variable": "HEDGEDOC_DB_PASSWORD" }, { "type": "text", "label": "Add port to URL", - "hint": "Set as False if using domain, true with an IP", + "hint": "Set as false if you are exposing app, otherwise set as true", "placeholder": "false", "required": true, - "env_variable": "CMD_URL_ADDPORT" + "env_variable": "HEDGEDOC_ADDPORT" } ] } diff --git a/apps/hedgedoc/docker-compose.yml b/apps/hedgedoc/docker-compose.yml index 4f1126c2..221af628 100644 --- a/apps/hedgedoc/docker-compose.yml +++ b/apps/hedgedoc/docker-compose.yml @@ -1,13 +1,13 @@ -version: "3.7" +version: '3.7' services: hedgedoc: - # Make sure to use the latest release from https://hedgedoc.org/latest-release + container_name: hedgedoc image: quay.io/hedgedoc/hedgedoc:1.9.7 environment: - - CMD_DB_URL=postgres://hedgedoc:${DB_PASSWORD}@hedgedoc-db:5432/hedgedoc + - CMD_DB_URL=postgres://hedgedoc:${HEDGEDOC_DB_PASSWORD}@hedgedoc-db:5432/hedgedoc - CMD_DOMAIN=${APP_DOMAIN} - - CMD_URL_ADDPORT=${CMD_URL_ADDPORT} + - CMD_URL_ADDPORT=${HEDGEDOC_ADDPORT} volumes: - ${APP_DATA_DIR}/data/hedgedoc-uploads:/hedgedoc/public/uploads ports: @@ -15,6 +15,8 @@ services: restart: always depends_on: - hedgedoc-db + networks: + - tipi_main_network labels: traefik.enable: ${APP_EXPOSED} traefik.http.routers.hedgedoc.rule: Host(`${APP_DOMAIN}`) @@ -22,13 +24,14 @@ services: traefik.http.routers.hedgedoc.service: hedgedoc traefik.http.routers.hedgedoc.tls.certresolver: myresolver traefik.http.services.hedgedoc.loadbalancer.server.port: 3000 + hedgedoc-db: container_name: hedgedoc-db image: postgres:13.4-alpine restart: unless-stopped environment: - POSTGRES_USER=hedgedoc - - POSTGRES_PASSWORD=${DB_PASSWORD} + - POSTGRES_PASSWORD=${HEDGEDOC_DB_PASSWORD} - POSTGRES_DB=hedgedoc volumes: - ${APP_DATA_DIR}/data/postgres:/var/lib/postgresql/data diff --git a/apps/hedgedoc/metadata/description.md b/apps/hedgedoc/metadata/description.md index 07d0e9f4..a12e7d9d 100644 --- a/apps/hedgedoc/metadata/description.md +++ b/apps/hedgedoc/metadata/description.md @@ -1,25 +1,15 @@ -![HedgeDoc Logo](docs/content/images/hedgedoc_logo_black.svg) - -[![#HedgeDoc on matrix.org][matrix.org-image]][matrix.org-url] -[![version][github-version-badge]][github-release-page] -[![POEditor][poeditor-image]][poeditor-url] -[![Mastodon][social-mastodon-image]][social-mastodon] -[![Twitter][social-twitter-image]][social-twitter] -![REUSE Compliance Check][reuse-workflow-badge] -![Nest.JS CI][nestjs-workflow-badge] -[![codecov][codecov-badge]][codecov-url] - -HedgeDoc lets you create real-time collaborative markdown notes. +HedgeDoc lets you create real-time collaborative markdown notes. ## Getting Started + - ℹ️ Read all about HedgeDoc and the history of the project on [our website](https://hedgedoc.org) - 🧪 Try out HedgeDoc with the [demo instance][hedgedoc-demo]. Check out the [features page][hedgedoc-demo-features]! - 💽 Install HedgeDoc yourself using the [install guide](https://docs.hedgedoc.org/setup/getting-started/) - ❓ Questions? Join our [Matrix chat][matrix.org-url] or the [community forums][hedgedoc-community] - 💬 Stay up to date by subscribing to the [release feed][github-release-feed] - ## State of the project + HedgeDoc 1.x is stable and used around the world, but the codebase has [grown over time](https://hedgedoc.org/history/), making it hard to add new features. We are currently working on HedgeDoc 2, a complete rewrite of HedgeDoc. Please note the following: @@ -28,4 +18,4 @@ We are currently working on HedgeDoc 2, a complete rewrite of HedgeDoc. Please n **If you are looking for the 1.x source code, have a look at the [master branch](https://github.com/hedgedoc/hedgedoc/tree/master).** - The 1.x release is maintenance-only. We do not accept feature requests or PRs for this release anymore and may choose to close non-critical bug reports, if the bug will be non-existent in 2.0. -- HedgeDoc 2 will be split in two components. The backend and the frontend. Both are present in this repository. \ No newline at end of file +- HedgeDoc 2 will be split in two components. The backend and the frontend. Both are present in this repository.