wanderer 项目安装与使用教程

wanderer 项目安装与使用教程

wanderer wanderer is a self-hosted trail database. Save your adventures! 项目地址: https://gitcode.com/gh_mirrors/wa/wanderer

1. 项目目录结构及介绍

wanderer 项目的目录结构如下：

wanderer/
├── db/
├── docs/
├── search/
├── web/
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── crowdin.yml
├── docker-compose.yml

目录介绍：

• db/: 数据库相关文件。
• docs/: 项目文档文件。
• search/: 搜索功能相关文件。
• web/: 前端相关文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。
• crowdin.yml: 多语言翻译配置文件。
• docker-compose.yml: Docker 配置文件，用于快速启动项目。

2. 项目启动文件介绍

wanderer 项目的启动主要依赖于 docker-compose.yml 文件。以下是该文件的主要内容：

version: '3.8'
services:
  web:
    image: flomp/wanderer:latest
    ports:
      - "3000:3000"
    environment:
      - ORIGIN=http://localhost:3000
      - MEILI_MASTER_KEY=your_master_key
    volumes:
      - ./db:/app/db
      - ./search:/app/search
      - ./web:/app/web

启动步骤：

1. 下载 docker-compose.yml 文件：

   wget https://raw.githubusercontent.com/Flomp/wanderer/main/docker-compose.yml
   

2. 使用 Docker Compose 启动项目：

   docker-compose up -d
   

3. 项目启动后，可以通过 http://localhost:3000 访问前端界面。

3. 项目配置文件介绍

wanderer 项目的主要配置文件是 docker-compose.yml，其中包含了环境变量和服务的配置。

主要配置项：

• ORIGIN: 前端访问的 URL，默认为 http://localhost:3000。
• MEILI_MASTER_KEY: 数据库的主密钥，用于安全访问。

注意事项：

• 如果在生产环境中使用 wanderer，请确保修改 MEILI_MASTER_KEY 以提高安全性。
• 如果 wanderer 不是在 http://localhost:3000 上运行，请修改 ORIGIN 变量以避免 CORS 错误。

通过以上步骤，您可以成功安装并启动 wanderer 项目，并根据需要进行配置。

wanderer wanderer is a self-hosted trail database. Save your adventures! 项目地址: https://gitcode.com/gh_mirrors/wa/wanderer