Files
LocalNav/README.md
T
dekun 3149770887 Add system settings, one-click deploy, and simplify embed UI.
Remove Gate scout auto-seeding and the manual hub login button while keeping Gate login and instance SSO. Add password change and database backup/restore, plus deploy scripts with env auto-generation.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-07-12 11:44:12 +08:00

33 lines
1.4 KiB
Markdown

# 本地导航站
Flask + SQLite 的局域网导航聚合:左侧分组与服务列表,右侧 iframe 内嵌打开 `http://内网IP:端口`,统一入口管理宝塔、面板、本地服务等。
**代码仓库:** https://git.bz121.com/dekun/LocalNav.git
**完整中文说明与部署文档:** [部署与使用说明.md](./部署与使用说明.md)
**默认端口:** `5070`(可通过环境变量 `NAV_PORT` 修改)
## 一键部署
```bash
# Linux / macOS
bash scripts/deploy.sh
# Windows PowerShell
.\scripts\deploy.ps1
# 或直接
python scripts/deploy.py
```
脚本会自动:检测 Python 环境、创建虚拟环境、安装依赖、从 `.env.example` 生成 `.env`、写入 `NAV_SECRET_KEY` 与默认账号。
**默认登录:** `admin` / `admin123`(生产环境请尽快在「系统设置」中修改密码)
配置:将 `.env.example` 复制为 `.env` 并填写变量(与 `app.py` 同目录);详见说明文档「环境变量与 `.env`」一节。
进程守护(可选):`pm2 start ecosystem.config.cjs`(需已安装 PM2),详见 [部署与使用说明.md](./部署与使用说明.md) 中「9.7 使用 PM2」。
**Ubuntu 生产部署(推荐):** 克隆到 `/opt/LocalNav`,以 **root** 用户运行 systemd 服务,默认监听 `5070`;外网访问请配置 Nginx/Caddy 反向代理与 HTTPS,详见部署文档「九、部署指南」与「9.8 外网 HTTPS 访问」。