https://github.com/Mereithhh/van-nav
一个轻量导航站，汇总你的所有服务。全平台支持，单文件部署，有配套浏览器插件
https://github.com/Mereithhh/van-nav
Last synced: about 1 month ago
JSON representation
一个轻量导航站，汇总你的所有服务。全平台支持，单文件部署，有配套浏览器插件
- Host: GitHub
- URL: https://github.com/Mereithhh/van-nav
- Owner: Mereithhh
- License: mit
- Created: 2021-12-19T10:22:21.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-17T07:01:09.000Z (4 months ago)
- Last Synced: 2025-03-23T23:12:25.637Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://demo-tools.mereith.com
- Size: 38.4 MB
- Stars: 753
- Watchers: 7
- Forks: 141
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - Mereithhh/van-nav - 一个轻量导航站，汇总你的所有服务。全平台支持，单文件部署，有配套浏览器插件 (TypeScript)
README
# Van Nav
一个轻量的导航站，现在有搜索引擎集成了，很适合作为主页使用。有配套的[浏览器插件](https://github.com/Mereithhh/van-nav-extension)和 API。 [在线体验](https://demo-tools.mereith.com) (总有人改后台数据，后台密码就不放出来了)
> 新增了 [API 文档](https://van-nav-api.mereith.dev)，用 AI 生成的，如果不准确请提 Issue 哦。
## 预览
### PC
### PAD
### PHONE
### 后台设置
### 交流群
> qq 交流群： 873773083
## 使用技巧/快捷键
其实这个导航站有很多小设计，合理使用可以提高使用效率：
- 只要在这个页面里，直接输入键盘任何按键，可以直接聚焦到搜索框开始输入。
- 搜索完按回车会直接在新标签页打开第一个结果。
- 搜索完按一下对应卡片右上角的数字按钮 + Ctrl(mac 也可以用 command 键) ，也会直接打开对应结果。
另外可以设置跳转方式哦。
## CHANGELOG
具体请看 [CHANGELOG.md](CHANGELOG.md)
## 安装方法
### Docker
```
docker run -d --name tools --restart always -p 6412:6412 -v /path/to/your/data:/app/data mereith/van-nav:latest
```
打开浏览器 [http://localhost:6412](http://localhost:6412) 即可访问。
- 默认端口 6412
- 默认账号密码 admin admin 第一次运行后请进入后台修改
- 数据库会自动创建在当前文件夹中： `nav.db`
### 可执行文件
下载 release 文件夹里面对应平台的二进制文件，直接运行即可。
打开浏览器 [http://localhost:6412](http://localhost:6412) 即可访问。
- 默认端口 6412 动时添加 `-port ` 参数可指定运行端口。
- 默认账号密码 admin admin ，第一次运行后请进入后台修改
- 数据库会自动创建在当前文件夹中： `nav.db`
### nginx 反向代理
参考配置
> 其中 `` 和 `` 替换成你自己的。
```
server {
listen 80;
server_name ;
return 301 https://$host$request_uri;
}
server {
listen 443 ssl http2;
server_name ;
ssl_certificate
ssl_certificate_key ;
ssl_verify_client off;
proxy_ssl_verify off;
location / {
proxy_pass http://127.0.0.1:6412;
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_redirect off;
proxy_set_header Upgrade $http_upgrade;
}
}
```
### systemd 服务
可以注册成系统服务，开机启动。
1. 复制二进制文件到 `/usr/local/bin` 目录下，并加上执行权限
2. 新建 `VanNav.serivce` 文件于 `/usr/lib/systemd/system` 目录下:
```
[Unit]
Description=VanNav
Documentation=https://github.com/mereithhh/van-nav
After=network.target
Wants=network.target
[Service]
WorkingDirectory=/usr/local/bin
ExecStart=/usr/local/bin/nav
Restart=on-abnormal
RestartSec=5s
KillMode=mixed
StandardOutput=null
StandardError=syslog
[Install]
WantedBy=multi-user.target
```
3. 执行:
```
sudo systemctl daemon-reload && sudo systemctl enable --now VanNav.service
```
## 浏览器插件
具体请看： [浏览器插件仓库](https://github.com/Mereithhh/van-nav-extension)
具有一键增加工具，快速打开管理后台和主站等功能。具体自行探索哦。
## API
本导航站支持 API，可以用自己的方法添加工具。
尝试用 ai 生成 api 文档，具体请看
> [API 文档](https://van-nav-api.mereith.dev)
## FAQ
- 忘记密码了怎么办： [看这里](https://github.com/Mereithhh/van-nav/issues/36)
## 参与开发
最近重构过一次，整体的代码结构暂时不会有大变动，所以欢迎参与开发！
如果你有 golang 和 react 开发经验，可以很轻松上手。
如果没有方向，可以试试去解决 issue 里的问题或者开发新功能，开发之前可以先提个 issue 让我知道。
## 状态
可以优化的点太多了，慢慢完善吧……
- [x] 多平台构建流水线
- [x] 定制化 logo 和标题
- [x] 导入导出功能
- [x] 暗色主题切换
- [x] 移动端优化
- [x] 自动获取网站 logo
- [x] 拼音匹配的模糊搜索功能
- [x] 按键直接搜索，搜索后回车直接打开第一项
- [x] 图片存库，避免跨域和加载慢的问题
- [x] gzip 全局压缩
- [x] 中文 url 图片修复
- [x] svg 图片修复
- [x] 浏览器插件
- [x] 自动获取网站题目和描述等信息
- [x] 后台按钮可自定义隐藏
- [x] github 按钮可隐藏
- [x] 支持登录后才能查看的隐藏卡片
- [x] 搜索引擎集成功能
- [x] 增加一些搜索后快捷键直接打开卡片
- [x] 支持自定义跳转方式
- [x] 自动主题切换
- [ ] 国际化
- [x] 增加 ServiceWork ,离线可用,可安装
- [ ] 网站状态检测
- [x] 支持后台设置默认跳转方式
- [x] 支持指定监听端口