多用途のドキュメント アプリケーション Codex Docs

コーデックス ドキュメントとは何ですか?

CodeX Docsは、社内文書、公共文書、または個人文書用のシンプルな無料アプリケーションです。これは に基づいておりEditor.js、コンテンツを適切かつクリーンにUI処理。

公式デモ サイトが提供されています: https://docs-demo.codex.so/about-this-demo

インストール

Synology の Docker モードでインストールします。

ミラーダウンロード

公式イメージはghcr.io、
アドレス: https://github.com/codex-team/codex.docs/pkgs/container/codex.docsで公開されています。

SSHクライアントでSynology にログインした後、次のコマンドを実行します。

# 拉取镜像
docker pull ghcr.io/codex-team/codex.docs:v2.1

科学的にインターネットをサーフィンしないと、プロキシ Web サイトhttps://dockerproxy.com/dockerを試すことができますが、さらにいくつかの手順が必要になります。

# 如果拉不动的话加个代理
docker pull ghcr.dockerproxy.com/codex-team/codex.docs:v2.1

# 重命名镜像（如果是通过代理下载的）
docker tag ghcr.dockerproxy.com/codex-team/codex.docs:v2.1 ghcr.io/codex-team/codex.docs:v2.1

# 删除代理镜像（如果是通过代理下载的）
docker rmi ghcr.dockerproxy.com/codex-team/codex.docs:v2.1

ダウンロードが完了すると、次の映像場所に

コマンドラインインストール

docker-composeインストール時には、以下の内容をdocker-compose.ymlファイルとして保存します

version: "3.2"

services:
  docs:
    image: ghcr.io/codex-team/codex.docs:v2.1
    container_name: codex-docs
    ports:
      - "3313:3000"
    command:
      - node
      - dist/backend/app.js
      - -c
      - docs-config.yaml
    volumes:
      - ./uploads:/usr/src/app/uploads
      - ./db:/usr/src/app/db
      - ./docs-config.yaml:/usr/src/app/docs-config.yaml

公式設定ファイルdocs-config.yamlを採用し、そのまま使用可能

各パラメータの説明については、公式ドキュメントを参照してください: https://docs-demo.codex.so/configuration

port: 3000
host: "localhost"
uploads:
  driver: "local"
  local:
    path: "./uploads"
  s3:
    bucket: "my-bucket"
    region: "eu-central-1"
    baseUrl: "http://docs-static.codex.so.s3-website.eu-central-1.amazonaws.com"
    keyPrefix: "/"
    accessKeyId: "my-access-key"
    secretAccessKey: "my-secret-key"
frontend:
  title: "CodeX Docs"
  description: "Free Docs app powered by Editor.js ecosystemt"
  startPage: ""
  misprintsChatId: "12344564"
  yandexMetrikaId: ""
  carbon:
    serve: ""
    placement: ""
  menu:
    - "Guides"
    - title: "CodeX"
      uri: "https://codex.so"

auth:
  password: secretpassword
  secret: supersecret

hawk:
#  frontendToken: "123"
#  backendToken: "123"

database:
  driver: local # you can change database driver here. 'mongodb' or 'local'
  local:
    path: ./db
#  mongodb:
#    uri: mongodb://localhost:27017/docs

次に、次のコマンドを実行します

# 新建文件夹 codex.docs 和子目录 
mkdir -p /volume2/docker/codex.docs/{
    
    data,db,uploads}

# 进入 codex.docs 目录
cd /volume2/docker/codex.docs

# 将 docker-compose.yml 和 docs-config.yaml 放入当前目录

# 一键启动
docker-compose up -d

走る

ブラウザに入力してメインインターフェイスhttp://群晖IP:3313を表示します

ポイント+Add page、最初にログインする必要があります

パスワードdocs-config.yamlはファイルauth.passwordに設定されていますsecretpassword

ログインに成功したら、新しいページの作成を開始できます

何気なく書く

保存されました

もう一度編集したほうがいいです。Alias数字と文字の両方で大丈夫です。

それ以外の場合は、再度開くhttp://群晖IP:3313と、次のように表示されます。Found. Redirecting to

Codex Docs特徴は、どのレベルでもドキュメントを作成でき、第 1 レベルのメニューの下に第 2 レベルのメニューを構築し、継続してドキュメントを構築できることです。

Editor.jsは、テキスト、画像、リスト、引用符など、さまざまなタイプのコンテンツを簡単に追加および配置できるオープンソースのブロック エディターです。各ブロックは個別のプラグインを通じて提供されるため、Editor.js非常に

付録、mongo データベースの使用

データベースはデフォルトでは使用されません。ページ データの保存mongoに、まずデータベースdocker-compose.ymlをインストールする必要があります。mongo

version: "3.2"

services:
  docs:
    image: ghcr.io/codex-team/codex.docs:v2.1
    container_name: codex-docs
    ports:
      - "3313:3000"
    command:
      - node
      - dist/backend/app.js
      - -c
      - docs-config.yaml
    volumes:
      - ./uploads:/usr/src/app/uploads
      - ./db:/usr/src/app/db
      - ./docs-config.yaml:/usr/src/app/docs-config.yaml
  
  mongodb:
    image: mongo:4.4.0
    container_name: codex-db
    ports:
      - "27017:27017"
    volumes:
      - ./data:/data/db

次のステップは、設定ファイルを変更して、の部分を から に変更することです。docs-config.yamldatabasedriverlocalmongodb

port: 3000
host: "localhost"
uploads:
  driver: "local"
  local:
    path: "./uploads"
  s3:
    bucket: "my-bucket"
    region: "eu-central-1"
    baseUrl: "http://docs-static.codex.so.s3-website.eu-central-1.amazonaws.com"
    keyPrefix: "/"
    accessKeyId: "my-access-key"
    secretAccessKey: "my-secret-key"
frontend:
  title: "CodeX Docs"
  description: "Free Docs app powered by Editor.js ecosystemt"
  startPage: ""
  misprintsChatId: "12344564"
  yandexMetrikaId: ""
  carbon:
    serve: ""
    placement: ""
  menu:
    - "Guides"
    - title: "CodeX"
      uri: "https://codex.so"

auth:
  password: secretpassword
  secret: supersecret

hawk:
#  frontendToken: "123"
#  backendToken: "123"

database:
  driver: mongodb # you can change database driver here. 'mongodb' or 'local'
  local:
    path: ./db
  mongodb:
    uri: mongodb://mongodb:27017/docs

参照文書

codex-team/codex.docs: Editor.js エコシステムを利用した無料のドキュメント アプリ
地址：https://github.com/codex-team/codex.docs

CodeX チームの
アドレス: https://codex.so/

CodeX ドキュメントの
アドレス: https://docs.codex.so/codex-docs