|
| 1 | +# 安装指南 |
| 2 | + |
| 3 | +TrailSnap 支持多种部署方式,推荐使用 Docker Compose 进行快速部署。 |
| 4 | + |
| 5 | +## Docker 部署 (推荐) |
| 6 | + |
| 7 | +使用 Docker Compose 可以一键启动所有服务,包括前端、后端、数据库和 AI 服务。 |
| 8 | + |
| 9 | +### 前置要求 |
| 10 | + |
| 11 | +- 安装 [Docker](https://docs.docker.com/get-docker/) 和 [Docker Compose](https://docs.docker.com/compose/install/)。 |
| 12 | +- 确保本地 5532, 8800, 8801, 8082 端口未被占用。 |
| 13 | + |
| 14 | +### 部署步骤 |
| 15 | + |
| 16 | +1. **获取 `docker-compose.yml`** |
| 17 | + |
| 18 | + 在项目根目录下创建一个 `docker-compose.yml` 文件,内容如下: |
| 19 | + |
| 20 | + ```yaml |
| 21 | + version: '3.8' |
| 22 | + |
| 23 | + services: |
| 24 | + postgres: |
| 25 | + image: pgvector/pgvector:pg18-trixie |
| 26 | + container_name: postgres_container |
| 27 | + restart: always |
| 28 | + environment: |
| 29 | + POSTGRES_DB: trailsnap |
| 30 | + POSTGRES_USER: trailsnap |
| 31 | + POSTGRES_PASSWORD: trailsnap |
| 32 | + POSTGRES_INITDB_ARGS: "--encoding=UTF8 --lc-collate=C --lc-ctype=C" |
| 33 | + PGDATA: /var/lib/postgresql/data/pgdata |
| 34 | + networks: [ app-network ] |
| 35 | + ports: |
| 36 | + - "5532:5432" |
| 37 | + volumes: |
| 38 | + - ./pg_data:/var/lib/postgresql/data |
| 39 | + healthcheck: |
| 40 | + test: ["CMD-SHELL", "pg_isready -U trailsnap -d trailsnap -p 5432"] |
| 41 | + interval: 5s |
| 42 | + timeout: 5s |
| 43 | + retries: 5 |
| 44 | + start_period: 10s |
| 45 | + |
| 46 | + server: |
| 47 | + image: siyuan044/trailsnap-server:master |
| 48 | + restart: always |
| 49 | + expose: [ "8000" ] |
| 50 | + ports: [ "8800:8000" ] |
| 51 | + networks: [ app-network ] |
| 52 | + volumes: |
| 53 | + - ./data:/app/data |
| 54 | + - /path/to/your/photos:/app/Photos/ # 请修改为你的照片目录路径 |
| 55 | + environment: |
| 56 | + - DB_URL=postgresql://trailsnap:trailsnap@postgres:5432/trailsnap |
| 57 | + - RAILWAY_DB_URL=postgresql://trailsnap:trailsnap@postgres:5432/railway |
| 58 | + - AI_API_URL=http://ai:8001 |
| 59 | + depends_on: |
| 60 | + postgres: |
| 61 | + condition: service_healthy |
| 62 | + restart: true |
| 63 | + |
| 64 | + ai: |
| 65 | + image: siyuan044/trailsnap-ai:master |
| 66 | + restart: always |
| 67 | + expose: [ "8001" ] |
| 68 | + ports: [ "8801:8001" ] |
| 69 | + networks: [ app-network ] |
| 70 | + volumes: |
| 71 | + - ./data:/app/data |
| 72 | + |
| 73 | + frontend: |
| 74 | + image: siyuan044/trailsnap-frontend:master |
| 75 | + restart: always |
| 76 | + ports: [ "8082:80" ] |
| 77 | + depends_on: [ server ] |
| 78 | + networks: [ app-network ] |
| 79 | + |
| 80 | + networks: |
| 81 | + app-network: |
| 82 | + driver: bridge |
| 83 | + ``` |
| 84 | +
|
| 85 | +2. **配置照片目录** |
| 86 | +
|
| 87 | + 修改 `server` 服务下的 `volumes` 配置,将 `/path/to/your/photos` 替换为你实际存放照片的本地目录路径。 |
| 88 | + |
| 89 | + Windows 用户示例: |
| 90 | + ```yaml |
| 91 | + - F:\Photos:/app/Photos/ |
| 92 | + ``` |
| 93 | + |
| 94 | + Linux/macOS 用户示例: |
| 95 | + ```yaml |
| 96 | + - /home/user/photos:/app/Photos/ |
| 97 | + ``` |
| 98 | + |
| 99 | +3. **启动服务** |
| 100 | + |
| 101 | + 在 `docker-compose.yml` 所在目录下执行: |
| 102 | + |
| 103 | + ```bash |
| 104 | + docker-compose up -d |
| 105 | + ``` |
| 106 | + |
| 107 | +4. **访问应用** |
| 108 | + |
| 109 | + 服务启动后,通过浏览器访问: |
| 110 | + - 前端页面: `http://localhost:8082` |
| 111 | + - 后端 API: `http://localhost:8800/docs` |
| 112 | + - AI 服务文档: `http://localhost:8801/docs` |
| 113 | + |
| 114 | +### 注意事项 |
| 115 | + |
| 116 | +- **数据持久化**: 数据库数据会保存在当前目录下的 `pg_data` 文件夹中,应用数据保存在 `data` 文件夹中。请勿随意删除这些目录,以免丢失数据。 |
| 117 | +- **端口冲突**: 如果默认端口被占用,请在 `docker-compose.yml` 中修改 `ports` 映射(例如 `8083:80`)。 |
| 118 | +- **照片权限**: 确保 Docker 容器有权限读取挂载的照片目录。 |
| 119 | + |
| 120 | +## 源码部署 |
| 121 | + |
| 122 | +如果你希望参与开发或进行二次开发,可以选择源码部署。详细步骤请参考 [开发者指南 - 快速开始](../dev/guide.md)。 |
0 commit comments