快速开始

起始页本体 [Nitaipage Main]

在线使用

开发版在线版

本地运行

v3.0.0 起项目迁移至 vue，v3.0.0 以下版本不适用以下运行方式

# 安装依赖
npm install

# 启动开发服务器
npm run dev

# 构建产物到 dist/
npm run build

# 预览构建结果
npm run preview

自建服务端 [Nitaipage Server]

直接部署

# 克隆仓库
git clone https://github.com/Nitai9h/nitaiPage-Server.git
cd nitaiPage-Server

cp .env.example .env
npm install
npm start

首次启动会下载并构建前端，时间较长

Docker 部署

# 克隆仓库
git clone https://github.com/Nitai9h/nitaiPage-Server.git
cd nitaiPage-Server

docker compose up -d --build

Docker-Compose 部署

services:
  nitaipage:
    build: .
    image: ghcr.io/nitai9h/nitaipage-server:latest
    container_name: nitaipage-server
    restart: unless-stopped

    ports:
      # 前端
      - "${WEB_PORT:-11123}:11123"
      # API 接口
      - "${API_PORT:-11125}:11125"

    environment:
      # 鉴权方式：pairing（默认，推荐）或 password
      AUTH_MODE: ${AUTH_MODE:-pairing}
      # 仅 password 时启用：APP_PASSWORD_HASH 优先
      APP_PASSWORD_HASH: ${APP_PASSWORD_HASH:-}
      APP_PASSWORD: ${APP_PASSWORD:-}
      # Token
      API_TOKEN: ${API_TOKEN:-}
      SESSION_MAX_AGE: ${SESSION_MAX_AGE:-2592000}
      LOGIN_MAX_FAILURES: ${LOGIN_MAX_FAILURES:-10}
      LOGIN_WINDOW_MS: ${LOGIN_WINDOW_MS:-900000}

      WEB_PORT: "11123"
      API_PORT: "11125"
      HOST: 0.0.0.0

      DATA_DIR: /app/data
      FRONTEND_DIR: /app/frontend

      # 指定前端仓库
      FRONTEND_REPO: ${FRONTEND_REPO:-https://github.com/Nitai9h/nitaipage}
      # 填写前端构建版本，重启后重建
      # 留空则使用镜像构建时的版本
      FRONTEND_REF: ${FRONTEND_REF:-}
      # false 则跳过构建
      PREPARE_FRONTEND: ${PREPARE_FRONTEND:-true}

      # true 则锁定数据库存储
      ONLY_SERVER: ${ONLY_SERVER:-false}
      # 指定 api 地址，同源不用填
      SERVER_URL: ${SERVER_URL:-}

      # 设备配对
      PAIRING_TTL: ${PAIRING_TTL:-600000}
      MAX_PENDING_PAIRINGS: ${MAX_PENDING_PAIRINGS:-20}
      DEVICE_TOKEN_MAX_AGE: ${DEVICE_TOKEN_MAX_AGE:-15552000}

      MAX_UPLOAD_BYTES: ${MAX_UPLOAD_BYTES:-209715200}

    volumes:
      # 用户数据
      - nitaipage-data:/app/data
      # 前端
      - nitaipage-frontend:/app/frontend
      # 为了方便管理可以使用以下形式：
      # - ./app/data:/app/data
      # - ./app/frontend:/app/frontend

    healthcheck:
      test:
        - CMD
        - node
        - -e
        - "fetch('http://127.0.0.1:11125/api/health').then(r => process.exit(r.ok ? 0 : 1)).catch(() => process.exit(1))"
      interval: 30s
      timeout: 5s
      retries: 3
      # 前端构建时间
      start_period: 600s

volumes:
  nitaipage-data:
  nitaipage-frontend:

docker compose up -d --build

注意：最新的 docker-compose.yml 文件可能有所修改，请以Github 仓库中的为准

配对

服务启动后，在浏览器中访问：

http://localhost:11123

页面会显示一个配对码，在服务器上执行以下命令进行批准：

docker compose exec nitaipage npm run pair -- AB3F9K2M

批准后，浏览器会自动进入起始页

浏览器扩展 [Browser extension]

当前浏览器扩展核心版本: v2.1.1 (版本说明)

在线商店

Edge 商店FireFox 商店CRX 搜搜

手动下载 (除 Firefox(ipa) 外,都需要手动更新)

CRX (v2.1.1)ZIP (v2.1.1)XPI (v2.1.1)