diff --git a/README.md b/README.md index 91f89f1d..3057080b 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ This is the official repository for the Tipi App Store. It contains all the apps - [Grocy](https://github.com/grocy/grocy) - Grocy - ERP beyond your fridge - [Haven](https://github.com/havenweb/haven) - Haven is a self-hosted private blog and feedreader you can use instead of Facebook - [Headscale](https://github.com/juanfont/headscale) - An open source, self-hosted implementation of the Tailscale control server +- [HedgeDoc](https://github.com/hedgedoc/hedgedoc) - A Collaborative Markdown and Note Taking App - [Homarr](https://github.com/ajnart/homarr) - A homepage for your server - [Home Assistant](https://github.com/home-assistant/core) - Open source home automation that puts local control and privacy first - [Immich](https://github.com/immich-app/immich) - Photo and video backup solution directly from your mobile phone diff --git a/apps/hedgedoc/config.json b/apps/hedgedoc/config.json new file mode 100644 index 00000000..0b4f240d --- /dev/null +++ b/apps/hedgedoc/config.json @@ -0,0 +1,32 @@ +{ + "$schema": "../schema.json", + "name": "HedgeDoc", + "port": 8142, + "available": true, + "exposable": true, + "id": "hedgedoc", + "tipi_version": 1, + "version": "1.9.7", + "categories": ["media"], + "description": "HedgeDoc (formerly known as CodiMD) is an open-source, web-based, self-hosted, collaborative markdown editor. You can use it to easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers and they’re ready to go.", + "short_desc": "A Collaborative Markdown and Note Taking App", + "website": "https://hedgedoc.org/", + "author": "https://github.com/hedgedoc", + "source": "https://github.com/hedgedoc/hedgedoc", + "form_fields": [ + { + "type": "random", + "label": "DB_PASSWORD", + "min": 32, + "env_variable": "DB_PASSWORD" + }, + { + "type": "text", + "label": "Add port to URL", + "hint": "Set as False if using domain, true with an IP", + "placeholder": "false", + "required": true, + "env_variable": "CMD_URL_ADDPORT" + } + ] +} diff --git a/apps/hedgedoc/docker-compose.yml b/apps/hedgedoc/docker-compose.yml new file mode 100644 index 00000000..4f1126c2 --- /dev/null +++ b/apps/hedgedoc/docker-compose.yml @@ -0,0 +1,36 @@ +version: "3.7" + +services: + hedgedoc: + # Make sure to use the latest release from https://hedgedoc.org/latest-release + image: quay.io/hedgedoc/hedgedoc:1.9.7 + environment: + - CMD_DB_URL=postgres://hedgedoc:${DB_PASSWORD}@hedgedoc-db:5432/hedgedoc + - CMD_DOMAIN=${APP_DOMAIN} + - CMD_URL_ADDPORT=${CMD_URL_ADDPORT} + volumes: + - ${APP_DATA_DIR}/data/hedgedoc-uploads:/hedgedoc/public/uploads + ports: + - ${APP_PORT}:3000 + restart: always + depends_on: + - hedgedoc-db + labels: + traefik.enable: ${APP_EXPOSED} + traefik.http.routers.hedgedoc.rule: Host(`${APP_DOMAIN}`) + traefik.http.routers.hedgedoc.entrypoints: websecure + 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_DB=hedgedoc + volumes: + - ${APP_DATA_DIR}/data/postgres:/var/lib/postgresql/data + networks: + - tipi_main_network diff --git a/apps/hedgedoc/metadata/description.md b/apps/hedgedoc/metadata/description.md new file mode 100644 index 00000000..07d0e9f4 --- /dev/null +++ b/apps/hedgedoc/metadata/description.md @@ -0,0 +1,31 @@ +![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. + +## 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: + +- This branch contains the latest development code and does not implement all features yet. + **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 diff --git a/apps/hedgedoc/metadata/logo.jpg b/apps/hedgedoc/metadata/logo.jpg new file mode 100644 index 00000000..dc9358fa Binary files /dev/null and b/apps/hedgedoc/metadata/logo.jpg differ