freefire
fde5f628ec
浏览器登录改为 DB sessions（可吊销）；敏感词与 OIDC PEM 入 settings； 落地安装向导、注册发帖与 /admin 仪表盘/板块/审核/设置。 Co-authored-by: Cursor <cursoragent@cursor.com>
186 lines
6.1 KiB
Markdown
186 lines
6.1 KiB
Markdown
# 关于本站 · 姜十三论坛
|
||
|
||
> 建议标题：关于本站 · 姜十三论坛
|
||
> 建议标签：`站务` `介绍`
|
||
> 建议操作：置顶（可选精华）
|
||
|
||
---
|
||
|
||
你好，欢迎加入本站。
|
||
|
||
这里运行的是开源论坛 **姜十三论坛（Jiang13 Forum）**——面向小圈子、团队与同好社群，目标很明确：
|
||
|
||
**能聊 · 好看 · 好装**
|
||
|
||
下文介绍它是什么、怎么上手、有哪些能力，以及为何采用单文件部署。读完即可开始发帖；细节可随时回来查阅。
|
||
|
||
---
|
||
|
||
## 一、它是什么
|
||
|
||
姜十三论坛不是大而全的社区平台，而是一款轻量、现代化的论坛软件。
|
||
|
||
它做好一件事：给「几人到几百人」的内部交流，一个干净、顺手、数据在自己手里的地方。
|
||
|
||
- 有板块、帖子、楼层回复，讨论能沉淀、能追溯
|
||
- 界面清爽，信息密度适中，桌面与手机都好用
|
||
- 单个程序即可部署，备份路径清晰
|
||
|
||
技术上，它是一个 **Go 单二进制**：前端页面内嵌，数据库用内置 **SQLite**。拷到服务器、启动、注册——就可以用。
|
||
|
||
### 谁适合用
|
||
|
||
| 场景 | 说明 |
|
||
| --- | --- |
|
||
| 团队 / 工作室 | 需求讨论、进度同步、知识沉淀 |
|
||
| 兴趣小圈子 | 同好交流、作品分享、活动组织 |
|
||
| 项目配套社区 | 可与 Gitea 等做 SSO 联动 |
|
||
| 个人站长 | 单机可跑，无需云数据库与一堆微服务 |
|
||
|
||
若你需要百万级公网社区、复杂插件生态或企业级工单流，它可能不是最优选。
|
||
若你要的是 **小而美、自己能装、自己能管**，就对了。
|
||
|
||
### 本板块说明
|
||
|
||
「站务公告」只发站务与介绍类内容。日常聊天、提问、分享，请到其他讨论板块。
|
||
|
||
---
|
||
|
||
## 二、三分钟上手
|
||
|
||
### 注册与登录
|
||
|
||
1. 打开注册页，填写用户名、邮箱与密码。
|
||
2. 若已开启邮件服务，可能需要邮箱验证码。
|
||
3. **第一个注册用户自动成为管理员**，无需安装向导。
|
||
|
||
登录后，右上角会出现头像与私信入口。
|
||
|
||
### 认识首页
|
||
|
||
| 区域 | 内容 |
|
||
| --- | --- |
|
||
| 左侧 | 板块导航、常用入口 |
|
||
| 中间 | 帖子列表（Feed） |
|
||
| 右侧 | 热门帖、最新评论等 |
|
||
|
||
列表可按 **最新发帖 / 最新回复 / 热门** 切换。
|
||
支持浅色 / 暗色主题，偏好会记住。手机上侧栏会收起，不影响浏览与发帖。
|
||
|
||
### 发帖与回复
|
||
|
||
点「发帖」→ 选板块 → 写标题、标签（可选）与正文。
|
||
正文支持富文本与图片上传。评论是 **楼层式** 的，可回复、引用、@。
|
||
|
||
帖子可点赞、收藏；公开主页可展示你的资料与动态。
|
||
|
||
### 个人入口
|
||
|
||
头像菜单常见项：个人主页、账号设置、站内私信、我的收藏。
|
||
|
||
### 管理后台（仅管理员）
|
||
|
||
访问 `/admin`：板块、帖子、评论、举报、用户、媒体、系统设置，以及备份等。
|
||
|
||
| 改什么 | 去哪里 |
|
||
| --- | --- |
|
||
| 端口、数据目录、DB、JWT | CLI / Env + `data/.jwt_secret`（改引导项需重启） |
|
||
| 品牌、OIDC、邮件、对象存储、限流、敏感词等 | 后台「系统设置」（保存即生效） |
|
||
|
||
逛完板块，发第一帖或回一楼——聊起来就对了。
|
||
|
||
---
|
||
|
||
## 三、功能速览
|
||
|
||
功能刻意收在「小圈子真正用得到」的范围内。
|
||
|
||
### 浏览与发帖
|
||
|
||
- 三栏布局，桌面 / 移动自适应
|
||
- Feed 排序与虚拟滚动
|
||
- 浅色 / 暗色主题；板块图标与主题色可配
|
||
- TipTap 富文本、标签、正文图片
|
||
- 楼层评论：回复、引用、@
|
||
- 点赞、收藏；置顶 / 精华
|
||
- 编辑修订历史（可对比差异）
|
||
- 可配置普通用户的编辑时限
|
||
|
||
### 社交与个人
|
||
|
||
- 公开用户主页
|
||
- 会话式站内私信
|
||
- 昵称、签名、头像等资料
|
||
|
||
### 管理后台
|
||
|
||
与前台同一套 React 体验，统一在 `/admin`：
|
||
|
||
| 模块 | 能力 |
|
||
| --- | --- |
|
||
| 仪表盘 | 站点概览 |
|
||
| 板块 | 创建、编辑、排序、外观 |
|
||
| 帖子 | 审核、置顶、精华、锁定、回收站 |
|
||
| 评论 / 举报 | 审核与处理 |
|
||
| 用户 | 禁言等 |
|
||
| 媒体 | 查看与清理上传 |
|
||
| 设置 | 品牌、限流、敏感词、邮件、OIDC、存储等 |
|
||
| 备份 | SQLite 一键备份 |
|
||
|
||
### 可选能力
|
||
|
||
按需在后台开启，不是装完就必须用：
|
||
|
||
- 邮件验证码注册
|
||
- OIDC Provider（可作 Gitea 等登录源）
|
||
- Gitea 公开仓库同步到「开源码桶」
|
||
- 本地磁盘或 S3 兼容对象存储
|
||
|
||
### 权限
|
||
|
||
只有两种角色：**普通用户** / **管理员**。
|
||
第一个注册用户即管理员。小圈子够用，不堆角色矩阵。
|
||
|
||
项目仍在积极开发。完整规划见仓库 `ROADMAP.md`，欢迎反馈与共建。
|
||
|
||
---
|
||
|
||
## 四、为什么是单文件部署
|
||
|
||
最硬核的一点，是部署路径极短——不是「理论上能打包」，而是日常用法就是：
|
||
|
||
1. 编译得到一个二进制
|
||
2. 放到目录里运行
|
||
3. 自动生成 `data/.jwt_secret`
|
||
4. 浏览器注册，第一个账号即管理员
|
||
|
||
### 它补哪块空缺
|
||
|
||
论坛方案常落在两端：很重（功能全、运维贵），或很碎（聊天 / 文档方便，却缺少发帖沉淀）。
|
||
小圈子往往需要中间态：有论坛结构、界面顺手、一个人能装、备份好懂。单文件部署，就是为后两点服务的。
|
||
|
||
### 具体意味着什么
|
||
|
||
| 能力 | 说明 |
|
||
| --- | --- |
|
||
| 单二进制 | 前端已内嵌，不必单独部署前端目录 |
|
||
| 内置 SQLite | 零外部数据库，数据在本地目录 |
|
||
| Env / CLI 引导 | 端口、数据目录、数据库 |
|
||
| 后台热配置 | OIDC、邮件、存储、品牌等保存即生效 |
|
||
| 系统服务 | 内置 Linux systemd / Windows Service |
|
||
| 跨平台 | Windows / Linux / macOS 均可编译运行 |
|
||
|
||
备份也直观：数据库、上传、配置结构清晰，拷贝即可留存。
|
||
|
||
进程级项改 Env/CLI 后重启；业务项在管理后台改。引导面保持精简，热更新走数据库。
|
||
|
||
---
|
||
|
||
## 写在最后
|
||
|
||
**姜十三论坛** = 小圈子该有的论坛能力 × 清新界面 × 真正能单文件带走的部署。
|
||
|
||
源码与说明见项目仓库。许可证：MIT。
|
||
|
||
有问题可联系管理员。祝你在这里聊得愉快。
|