快速开始

本指南将帮助您在 5 分钟内 部署 NavLink 导航站。

💡推荐使用 Docker 部署，简单快捷，支持一键升级

环境要求

项目	要求
Docker	20.10+（推荐）
内存	1GB+
磁盘	1GB+

Docker 部署

方式一：使用 docker-compose（推荐）

1. 创建项目目录

mkdir navlink && cd navlink

2. 创建 docker-compose.yml

services:
  navlink:
    image: ghcr.io/txwebroot/navlink-releases:latest
    container_name: navlink-app
    hostname: navlink-app  # 固定 hostname，防止升级后指纹变化需重新激活
    restart: unless-stopped
    ports:
      - "8000:3002"
    environment:
      - TZ=Asia/Shanghai
      - NODE_ENV=production
      - JWT_SECRET=your-secret-key-change-me
      - DEFAULT_ADMIN_PASSWORD=admin123
    volumes:
      - ./data:/app/data
      - ./plugins:/app/plugins
      - ./logs:/app/logs
      # Docker 插件需要（可选）
      - /var/run/docker.sock:/var/run/docker.sock

3. 启动服务

docker compose up -d

4. 访问站点

打开浏览器访问 http://localhost:8000

💡 默认账户

• 用户名：admin
• 密码：admin123

⚠️ 请登录后立即修改密码！

---

方式二：直接使用 docker run

docker run -d \
  --name navlink \
  --hostname navlink-app \
  -p 8000:3002 \
  -e TZ=Asia/Shanghai \
  -e JWT_SECRET=your-secret-key \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/plugins:/app/plugins \
  ghcr.io/txwebroot/navlink-releases:latest

---

验证部署

1

访问站点

打开 http://localhost:8000

2

登录后台

使用默认账号登录

3

修改密码

进入设置修改密码

常见问题

端口被占用？

修改 docker-compose.yml 中的端口映射：

ports:
  - "8080:3002"  # 改为 8080 或其他端口

容器无法启动？

查看日志排查问题：

docker logs navlink-app

下一步

• 📖 Docker 部署详解 - 更多配置选项
• ⚙️ 配置说明 - 自定义您的导航站
• ❓ 常见问题 - 遇到问题？