diff options
| author | Bruce Huang <helbingxxx@gmail.com> | 2022-10-08 11:36:49 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-08 03:36:49 +0000 |
| commit | 02049bf68d5389140e62393cd90e310e9e2749e4 (patch) | |
| tree | eaa5f6077be80512d20f75ee597a730a40382dac /docs/zh-CN/server.md | |
| parent | add some error messages (#510) (diff) | |
| download | atuin-02049bf68d5389140e62393cd90e310e9e2749e4.zip | |
update zh-CN docs (#539)
* update zh-CN docs
* update zh-CN docs
* update zh-CN docs
* update zh-CN docs
Diffstat (limited to 'docs/zh-CN/server.md')
| -rw-r--r-- | docs/zh-CN/server.md | 93 |
1 files changed, 7 insertions, 86 deletions
diff --git a/docs/zh-CN/server.md b/docs/zh-CN/server.md index 534cb674..4cb39df9 100644 --- a/docs/zh-CN/server.md +++ b/docs/zh-CN/server.md @@ -61,94 +61,15 @@ Atuin 服务器应该监听的端口 一个有效的 postgres URI, 用户和历史记录数据将被保存到其中。 -## Docker +### path -提供了一个 docker 镜像(image),可以更轻松地将服务器部署为容器(container)。 +path 指的是给 server 添加的路由前缀。值为空字符串将不会添加路由前缀。 -```sh -docker run -d -v "$USER/.config/atuin:/config" ghcr.io/ellie/atuin:latest server start -``` - -## Docker Compose - -使用已有的 docker 镜像(image)来托管你自己的 Atuin,可以使用提供的 docker-compose 文件来完成 - -在 `docker-compose.yml` 同级目录下创建一个 `.env` 文件,内容如下: - -``` -ATUIN_DB_USERNAME=atuin -# Choose your own secure password -ATUIN_DB_PASSWORD=really-insecure -``` - -创建一个 `docker-compose.yml` 文件: - -```yaml -version: '3.5' -services: - atuin: - restart: always - image: ghcr.io/ellie/atuin:main - command: server start - volumes: - - "./config:/config" - links: - - postgresql:db - ports: - - 8888:8888 - environment: - ATUIN_HOST: "0.0.0.0" - ATUIN_OPEN_REGISTRATION: "true" - ATUIN_DB_URI: postgres://$ATUIN_DB_USERNAME:$ATUIN_DB_PASSWORD@db/atuin - postgresql: - image: postgres:14 - restart: unless-stopped - volumes: # 不要删除索引数据库文件的永久存储空间! - - "./database:/var/lib/postgresql/data/" - environment: - POSTGRES_USER: $ATUIN_DB_USERNAME - POSTGRES_PASSWORD: $ATUIN_DB_PASSWORD - POSTGRES_DB: atuin -``` - -使用 `docker-compose` 启动服务: - -```sh -docker-compose up -d -``` - -### 使用 systemd 来管理你的 Atuin 服务器 - -以下 `systemd` 单元文件用于管理您的 `docker-compose` 托管服务: - -``` -[Unit] -Description=Docker Compose Atuin Service -Requires=docker.service -After=docker.service - -[Service] -# docker-compose 文件所在的位置 -WorkingDirectory=/srv/atuin-server -ExecStart=/usr/bin/docker-compose up -ExecStop=/usr/bin/docker-compose down -TimeoutStartSec=0 -Restart=on-failure -StartLimitBurst=3 - -[Install] -WantedBy=multi-user.target -``` - -使用以下命令启动并启用服务: +默认为 `""` -```sh -systemctl enable --now atuin -``` +## 容器部署说明 -检查它是否运行: - -```sh -systemctl status atuin -``` +你可以在容器中部署自己的 atuin 服务器: +* 有关 docker 配置的示例,请参考 [docker](docker.md)。 +* 有关 kubernetes 配置的示例,请参考 [k8s](k8s.md)。 |
