diff --git a/.gitignore b/.gitignore index 5e3c552a..382433b6 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ node_modules/ package-lock.json github.secrets +.DS_Store diff --git a/apps/codex-docs/config.json b/apps/codex-docs/config.json new file mode 100644 index 00000000..37392783 --- /dev/null +++ b/apps/codex-docs/config.json @@ -0,0 +1,37 @@ +{ + "$schema": "../schema.json", + "name": "CodeX.docs", + "available": true, + "exposable": true, + "port": 8086, + "id": "codex-docs", + "tipi_version": 1, + "version": "v2", + "categories": ["media"], + "description": "CodeX Docs is a free docs application. It's based on Editor.js ecosystem which gives all modern opportunities for working with content. You can use it for product documentation, for internal team docs, for personal notes or any other need. ", + "short_desc": "Free Docs app powered by Editor.js ecosystem.", + "author": "https://docs.codex.so/", + "source": "https://github.com/codex-team/codex.docs", + "form_fields": [ + { + "type": "password", + "label": "Auth Password", + "max": 50, + "min": 3, + "required": true, + "env_variable": "APP_CONFIG_auth_password" + }, + { + "type": "random", + "label": "MONGO_INITDB_ROOT_PASSWORD", + "min": 32, + "env_variable": "MONGO_INITDB_ROOT_PASSWORD" + }, + { + "type": "random", + "label": "APP_CONFIG_auth_secret", + "min": 32, + "env_variable": "APP_CONFIG_auth_secret" + } + ] +} diff --git a/apps/codex-docs/docker-compose.yml b/apps/codex-docs/docker-compose.yml new file mode 100644 index 00000000..2de46630 --- /dev/null +++ b/apps/codex-docs/docker-compose.yml @@ -0,0 +1,34 @@ +version: "3.2" + +services: + codex-docs: + image: ghcr.io/codex-team/codex.docs:v2 + ports: + - ${APP_PORT}:3000 + restart: unless-stopped + environment: + - APP_CONFIG_auth_password=${APP_CONFIG_auth_password} + - APP_CONFIG_auth_secret=${APP_CONFIG_auth_secret} + - APP_CONFIG_database_driver=mongodb + - APP_CONFIG_database_mongodb_uri=mongodb://tipi:${mongoPassword}@codex-mongo:27017`, + volumes: + - ${APP_DATA_DIR}/data/uploads:/usr/src/app/uploads + - ${APP_DATA_DIR}/data/db:/usr/src/app/db + - ${APP_DATA_DIR}/data/docs-config.yaml:/usr/src/app/docs-config.yaml + networks: + - tipi_main_network + labels: + traefik.enable: ${APP_EXPOSED} + traefik.http.routers.codex-docs.rule: Host(`${APP_DOMAIN}`) + traefik.http.routers.codex-docs.entrypoints: websecure + traefik.http.routers.codex-docs.service: codex-docs + traefik.http.routers.codex-docs.tls.certresolver: myresolver + traefik.http.services.codex-docs.loadbalancer.server.port: 80 + codex-mongo: + image: mongo + restart: always + environment: + MONGO_INITDB_ROOT_USERNAME: tipi + MONGO_INITDB_ROOT_PASSWORD: ${MONGO_INITDB_ROOT_PASSWORD} + networks: + - tipi_main_network \ No newline at end of file diff --git a/apps/codex-docs/metadata/description.md b/apps/codex-docs/metadata/description.md new file mode 100644 index 00000000..7a9b4fc9 --- /dev/null +++ b/apps/codex-docs/metadata/description.md @@ -0,0 +1,40 @@ +# CodeX Docs + +### Custom Config, view Here https://github.com/codex-team/codex.docs/blob/main/docs-config.yaml +### Can Also Be configured with ENV, see here https://docs.codex.so/configuration#override-properties-with-environment-variables + +[CodeX Docs](https://docs.codex.so/) is a free docs application. It's based on Editor.js ecosystem which gives all modern opportunities for working with content. + +You can use it for product documentation, for internal team docs, for personal notes or any other need. + +![page-overview-bright](https://user-images.githubusercontent.com/3684889/190149130-6a6fcdec-09bc-4f96-8bdc-5ff4d789f248.png) + +It's super easy to install and use. + +## Features + +- 🤩 [Editor.js](https://editorjs.io/) ecosystem powered +- 📂 Docs nesting — create any structure you need +- 📱 Nice look on Desktop and Mobile +- 🔥 Beautiful page URLs. Human-readable and SEO-friendly. +- 🦅 [Hawk](https://hawk.so/?from=docs-demo) is hunting. Errors tracking integrated +- 💌 [Misprints](https://github.com/codex-team/codex.misprints) reports to the Telegram / Slack +- 📈 [Yandex Metrica](https://metrica.yandex.com/about) integrated +- 🚢 Deploy easily — no DB and other deps required +- 🤙 Simple configuration +- ⚙️ Tune UI as you need. Collapse sections, hide the Sidebar + +## Demo + +Here is our [Demo Application](https://docs-demo.codex.so/) where you can try CodeX Docs in action. + +## Guides + +1. [Getting Started](https://docs.codex.so/getting-started) +2. [Configuration](https://docs.codex.so/configuration) +3. [Kubernetes deployment](https://docs.codex.so/k8s-deployment) +4. [Authentication](https://docs.codex.so/authentication) +5. [Writing](https://docs.codex.so/writing) +6. [How to enable analytics](https://docs.codex.so/yandex-metrica) +7. [Contribution guide](https://docs.codex.so/contribution) + diff --git a/apps/codex-docs/metadata/logo.jpg b/apps/codex-docs/metadata/logo.jpg new file mode 100644 index 00000000..c155cd7e Binary files /dev/null and b/apps/codex-docs/metadata/logo.jpg differ