Merge branch 'DrMxrcy-app/codex-docs'

This commit is contained in:
Nicolas Meienberger 2023-03-01 19:54:28 +01:00
commit 4f16b0eb70
8 changed files with 119 additions and 1 deletions

1
.gitignore vendored
View File

@ -1,3 +1,4 @@
node_modules/
package-lock.json
github.secrets
.DS_Store

View File

@ -10,6 +10,7 @@ This is the official repository for the Tipi App Store. It contains all the apps
- [Bookstack](https://github.com/BookStackApp/BookStack) - Simple, easy-to-use platform for organising and storing information.
- [Calibre-Web](https://github.com/janeczku/calibre-web) - Web Ebook Reader
- [Code-Server](https://github.com/coder/code-server) - Web VS Code
- [Codex.Docs](https://github.com/codex-team/codex.docst) - Free Docs app powered by Editor.js ecosystem.
- [Filebrowser](https://github.com/filebrowser/filebrowser) - Web File Browser
- [Firefly III](https://github.com/firefly-iii/firefly-iii) - A personal finances manager
- [Flatnotes](https://github.com/Dullage/flatnotes) - A self-hosted, database-less note taking web app

View File

@ -3,7 +3,7 @@
"name": "Code-Server - Web VS Code",
"available": true,
"exposable": true,
"port": 8101,
"port": 8138,
"id": "code-server",
"tipi_version": 5,
"version": "4.8.3",

View File

@ -0,0 +1,37 @@
{
"$schema": "../schema.json",
"name": "CodeX.docs",
"available": true,
"exposable": true,
"port": 8101,
"id": "codex-docs",
"tipi_version": 1,
"version": "v2.1",
"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": "CODEX_AUTH_PASSWORD"
},
{
"type": "random",
"label": "CODEX_DB_PASSWORD",
"min": 32,
"env_variable": "CODEX_DB_PASSWORD"
},
{
"type": "random",
"label": "CODEX_AUTH_SECRET",
"min": 32,
"env_variable": "CODEX_AUTH_SECRET"
}
]
}

View File

@ -0,0 +1,2 @@
### 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

View File

@ -0,0 +1,37 @@
version: '3.2'
services:
codex-docs:
container_name: codex-docs
image: ghcr.io/codex-team/codex.docs:v2.1
ports:
- ${APP_PORT}:3000
restart: unless-stopped
environment:
- APP_CONFIG_auth_password=${CODEX_AUTH_PASSWORD}
- APP_CONFIG_auth_secret=${CODEX_AUTH_SECRET}
- APP_CONFIG_database_driver=mongodb
- APP_CONFIG_database_mongodb_uri=mongodb://tipi:${CODEX_DB_PASSWORD}@codex-db: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: 3000
codex-db:
container_name: codex-db
image: mongo:latest
restart: always
environment:
MONGO_INITDB_ROOT_USERNAME: tipi
MONGO_INITDB_ROOT_PASSWORD: ${CODEX_DB_PASSWORD}
networks:
- tipi_main_network

View File

@ -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)

Binary file not shown.

After

Width:  |  Height:  |  Size: 132 KiB