文档目录
开始使用

快速开始

在本地或测试环境启动 ]project-open[,完成初始化并创建第一个项目。

最后更新:2026-10-28

准备条件

开始之前,请确认本机具备:

  • Linux 或 macOS(Windows 建议使用 WSL2);
  • Docker 24+ 与 Docker Compose v2;
  • 至少 4 GB 可用内存、10 GB 磁盘空间;
  • 一个可用的浏览器。

生产部署请先阅读环境要求,本地体验不必完全满足生产规格。

方式一:使用容器启动

准备一个工作目录,写入 compose.yaml:

services:
  db:
    image: postgres:16
    environment:
      POSTGRES_DB: projectopen
      POSTGRES_USER: projectopen
      POSTGRES_PASSWORD: change-me
    volumes:
      - db-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U projectopen"]
      interval: 10s
      retries: 10

  app:
    image: ${PROJECT_OPEN_IMAGE:?请填写你构建或获取的镜像地址}
    depends_on:
      db:
        condition: service_healthy
    environment:
      DB_HOST: db
      DB_NAME: projectopen
      DB_USER: projectopen
      DB_PASSWORD: change-me
    ports:
      - "8000:8000"
    volumes:
      - app-data:/var/lib/project-open

volumes:
  db-data:
  app-data:

启动服务:

export PROJECT_OPEN_IMAGE=<你的镜像地址>
docker compose up -d
docker compose logs -f app

当日志出现服务已就绪的提示后,访问 http://localhost:8000。

说明:镜像来源与初始化方式取决于你的版本和部署包。社区文档不绑定特定镜像仓库;如果使用自建镜像,请参考架构概览确认启动脚本与配置目录。

方式二:从源码安装

源码安装适合需要二次开发的团队,典型步骤如下:

# 1. 创建数据库
createdb -U postgres projectopen

# 2. 获取源码并放置到 OpenACS 服务目录
git clone <project-open 源码地址> /srv/project-open
cd /srv/project-open

# 3. 配置数据库连接与站点参数
cp etc/config.tcl.example etc/config.tcl
$EDITOR etc/config.tcl

# 4. 启动 NaviServer
/usr/local/ns/bin/nsd -f -t etc/config.tcl

首次启动后,通过安装向导完成数据库初始化与包安装。安装过程会创建系统管理员账号,请立即修改默认口令。

初始化站点

  1. 使用管理员账号登录;
  2. 在系统设置中确认公司信息、时区、默认币种;
  3. 创建至少一个客户(Company)与一个项目(Project);
  4. 为项目添加任务,并把任务分配给成员;
  5. 用普通成员账号登录,录入一条工时,确认数据可见。

完成以上步骤,说明核心链路已经打通:客户 → 项目 → 任务 → 工时。

常见问题

页面提示数据库连接失败

检查数据库是否已启动、DB_HOST 是否指向正确容器,以及数据库用户是否有建表权限。

登录后中文显示异常

确认数据库编码为 UTF-8,并在站点配置中设置正确的语言与字符集。可参考中文环境配置。

端口被占用

修改 compose 中的端口映射,例如 "8080:8000",然后重新启动服务。

下一步