使用文档快速开始

快速开始

使用 GHCR 预构建镜像启动 Feronavi,创建组织和管理员账号。

准备环境

准备 Docker 24 或更新版本,以及 Docker Compose v2。默认镜像从 GitHub Container Registry 拉取,无需安装 Node.js、pnpm 或在本机编译。建议至少 2 核 CPU、4 GB 内存和 40 GB 可用磁盘用于试用。正式环境按数据库和附件增长规划容量。

默认使用 ghcr.io/feronavi/feronavi-app 与 ghcr.io/feronavi/feronavi-db。应用提供 0.1.0 和 latest 标签,数据库镜像使用 PostgreSQL 16 标签 16。生产部署可在 .env 中设置 FERONAVI_VERSION=0.1.0 固定应用版本。

获取部署文件

从产品仓库下载 compose.yaml,保存在单独的部署目录中。也可以在终端执行:

mkdir feronavi-deploy && cd feronavi-deploy && \
  curl -fL https://raw.githubusercontent.com/JasperPengC/feronavi/main/compose.yaml -o compose.yaml

该命令新建目录并下载 main 分支的部署配置。后续命令都在这个目录执行;如果已有部署目录,直接进入该目录,不要覆盖现有配置。

生成数据库密码

首次安装使用随机密码创建本地 .env 文件。以下命令不会覆盖已经存在的 .env。

(umask 077; test -e .env || echo "DB_PASSWORD=$(openssl rand -hex 24)" > .env)

若 .env 已存在,请确认其中设置了非空的 DB_PASSWORD。不要提交 .env,也不要将它放进公共网站。

拉取并启动

以下命令拉取预构建镜像并启动服务:

docker compose pull
docker compose up -d --wait
docker compose ps

系统包含应用、后台 worker、数据库与缓存服务。等待各服务健康后再继续。如需从源码构建开发镜像,可使用 compose.source.yaml 覆盖配置。

完成安装向导

在服务器本机打开 http://127.0.0.1:3000/setup,按照向导创建组织和管理员。

远程服务器默认只绑定本机回环地址。你可以先通过 SSH 转发到本地:

ssh -L 3000:127.0.0.1:3000 your-user@your-server

保持该终端连接,在自己的浏览器访问 http://127.0.0.1:3000/setup。命令中的账号和服务器地址需要替换为实际值。

创建第一项工作

  1. 登录后创建项目,设置项目名称和标识。
  2. 添加参与成员,并确认他们具备项目访问权限。
  3. 创建一个需求或任务,填写负责人、优先级与截止日期。
  4. 在看板中更新任务状态,在项目文档中记录方案。

接下来阅读项目与计划。给团队开放访问前,完成生产部署中的 HTTPS、反向代理与备份配置。

查看启动日志

docker compose logs --tail=100 app worker

数据库连接失败时,先核对 .env 和服务状态;镜像拉取失败时检查 GitHub Container Registry 访问和镜像标签。

输入关键词,搜索全部使用文档。