项目介绍
hello_github_share 是基于 FastAPI 的项目导航,支持分类、GitHub 仓库信息与管理后台。适合建立一个轻量项目目录,也便于对照自己的 Halo 项目集合所需字段。
项目卡片汇集仓库描述与指标,分类负责组织目录,后台完成维护。自动获取的信息适合作为草稿依据,介绍仍应人工核对。
适合轻量 GitHub 项目展示。先确定自己的分类与字段,再导入少量仓库。
核心功能
| 功能 | 作用与使用方式 |
|---|---|
| 仓库搜索 | 查找明确项目 |
| 信息卡片 | 展示描述与指标 |
| 多级分类 | 组织目录 |
| 后台管理 | 维护链接与内容 |
| 摘要功能 | 按当前版本配置模型 |
功能示意

图 1:自制功能示意图,概括本文的使用要点。

项目信息
| 项目 | 说明 |
|---|---|
| 类型 | 项目指南 |
| 分类 | 建站与协作 |
| 项目仓库 | luler/hello_github_share |
| 整理日期 | 2026-11-14 |
群晖 Compose 安装
上游原 Compose 将整个项目目录挂载到 /app,空目录会遮住镜像程序。本配置只映射 SQLite 数据库文件,并在启动前创建文件,避免它被 Docker 当成目录创建。GitCard 是可选的独立卡片服务,未部署时不预填一个无法访问的 localhost:3000。
1. 创建项目目录
群晖先安装并启动 Container Manager。通过 SSH 登录后执行下列命令,只为本项目准备目录:
sudo -i
mkdir -p /volume1/docker/hello-github-share
cd /volume1/docker/hello-github-share
if [ ! -s .env ]; then
umask 077
{
printf 'GH_NAV_ADMIN_PASSWORD=%s\n' "$(openssl rand -hex 24)"
printf 'GH_NAV_JWT_SECRET=%s\n' "$(openssl rand -hex 32)"
} > .env.initializing
mv .env.initializing .env
fi
chmod 600 .env
if [ ! -e /volume1/docker/hello-github-share/github_navigator.db ]; then touch /volume1/docker/hello-github-share/github_navigator.db; fi
cat .env
.env 中的密码和密钥由命令随机生成,已有文件不会覆盖。可以在自己的终端用 cat .env 查看初始密码,但不要将输出公开。将其保存在自己的密码管理器中;更新时继续使用原值,不要重新生成导致旧数据无法解密。
2. 保存完整 Compose
在 /volume1/docker/hello-github-share/compose.yaml 保存下面的配置。在 Container Manager 中新建项目时,项目路径选择 /volume1/docker/hello-github-share 并导入该文件;有 .env 的项目要保留它与 Compose 在同一目录。
services:
hello-github-share:
image: ghcr.io/luler/hello_github_share:latest
container_name: hello-github-share
restart: unless-stopped
ports:
- 8000:8000
volumes:
- /volume1/docker/hello-github-share/github_navigator.db:/app/github_navigator.db
environment:
ADMIN_USERNAME: admin
ADMIN_PASSWORD: ${GH_NAV_ADMIN_PASSWORD}
JWT_SECRET: ${GH_NAV_JWT_SECRET}
挂载参数冒号左侧是群晖的实际目录,右侧是应用内目录。以上只挂载本项目所需的数据;若已有同类数据,请先备份再调整路径。端口冲突时只改宿主机一侧,应用内端口保持不变。
3. 检查、拉取与启动
cd /volume1/docker/hello-github-share
docker compose config --quiet
docker compose pull
docker compose up -d
docker compose ps
docker compose logs --tail=100
浏览器访问 http://群晖IP:8000。群晖IP 替换为自己的 NAS 局域网地址;首次启动时先等待初始化,再检查日志。若群晖仍使用旧 Docker 套件且只有 docker-compose,将命令中的 docker compose 替换为对应命令。
首次使用与验证
访问 /admin,用 admin 和生成的管理员密码登录,先建立分类,再添加一个 GitHub 项目 URL。检查首页分类筛选和仓库卡片;要使用独立 GitCard 服务时再添加其可访问地址。
先保存一条测试数据或完成一次最小任务,再执行 docker compose restart,确认设置及应该持久化的数据仍在。无服务端持久化目录的纯前端工具,应通过自身导出功能保存工作结果。
常见问题
- 页面打不开:运行
docker compose ps检查状态;查看日志里的初始化错误,核对端口冲突和 DSM 防火墙。不要把容器的 IP 当作固定访问地址。 - 数据目录为空:应用内应填写 Compose 冒号右侧的目录;核对宿主机文件是否已放到对应左侧目录。
- 目录无法写入:先查看日志和目录权限,仅为对应数据目录授予镜像实际运行用户需要的权限,不对整个
/volume1设置 777。 - 拉取镜像失败:先排查 Container Manager 的仓库网络;应用自己的 HTTP 代理设置与 Docker 守护进程拉取镜像的代理设置是两件事。
更新、备份与停止
更新前保存 compose.yaml、.env,并备份上面映射的项目数据。数据库服务应先使用自身的数据库备份,或停止整个项目后复制完整数据目录,不能只复制运行中的单个数据库文件。
cd /volume1/docker/hello-github-share
docker compose pull
docker compose up -d
docker compose logs --tail=100
临时停止使用 docker compose stop,重新启动使用 docker compose start。卸载容器用 docker compose down,不要附加 -v,也不要直接删除宿主机数据目录。涉及数据库迁移的升级,先保留原镜像版本和完整备份,再安排维护窗口。