55
docs/site-posts/01-welcome.md
Normal file
55
docs/site-posts/01-welcome.md
Normal file
@@ -0,0 +1,55 @@
|
|||||||
|
# 欢迎来到本站
|
||||||
|
|
||||||
|
> 建议标题:欢迎来到本站
|
||||||
|
> 建议标签:`站务` `介绍`
|
||||||
|
> 建议操作:置顶(可选精华)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
你好,欢迎加入本站。
|
||||||
|
|
||||||
|
这里运行的是开源论坛程序 **姜十三论坛(Jiang13 Forum)**。
|
||||||
|
它面向小圈子、团队与同好社群,目标很简单:
|
||||||
|
|
||||||
|
**能聊 · 好看 · 好装**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 这是什么
|
||||||
|
|
||||||
|
姜十三论坛不是「大而全」的社区平台,而是一个轻量、现代化的论坛:
|
||||||
|
|
||||||
|
- 有板块、帖子、楼层回复,讨论能沉淀、能追溯
|
||||||
|
- 界面清爽,信息密度适中,桌面与手机都好用
|
||||||
|
- 单个程序即可部署,数据在自己手里
|
||||||
|
|
||||||
|
技术上,它是一个 **Go 单二进制**:前端页面内嵌,数据库用内置 **SQLite**。
|
||||||
|
拷到服务器、启动、注册——就可以开始用。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 谁适合用
|
||||||
|
|
||||||
|
| 场景 | 说明 |
|
||||||
|
| --- | --- |
|
||||||
|
| 团队 / 工作室 | 需求讨论、进度同步、知识沉淀 |
|
||||||
|
| 兴趣小圈子 | 同好交流、作品分享、活动组织 |
|
||||||
|
| 项目配套社区 | 可与 Gitea 等工具做 SSO 联动 |
|
||||||
|
| 个人站长 | 单机可跑,无需云数据库与一堆微服务 |
|
||||||
|
|
||||||
|
如果你需要的是百万级公网社区、复杂插件生态或企业级工单流,它可能不是最优选。
|
||||||
|
如果你要的是 **小而美、自己能装、自己能管**,就对了。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 本板块说明
|
||||||
|
|
||||||
|
「站务公告」只发布:
|
||||||
|
|
||||||
|
- 本站介绍与使用指引
|
||||||
|
- 规则与站务通知
|
||||||
|
- 与姜十三论坛相关的说明
|
||||||
|
|
||||||
|
日常聊天、提问、分享,请到其他讨论板块。
|
||||||
|
|
||||||
|
有问题可联系管理员。祝你在这里聊得愉快。
|
||||||
87
docs/site-posts/02-getting-started.md
Normal file
87
docs/site-posts/02-getting-started.md
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
# 三分钟上手本站
|
||||||
|
|
||||||
|
> 建议标题:三分钟上手本站
|
||||||
|
> 建议标签:`站务` `指南`
|
||||||
|
> 建议操作:普通发布
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
这篇给你一条最短路径:从注册到发第一帖,再到(如果是管理员)进入后台。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 1. 注册与登录
|
||||||
|
|
||||||
|
1. 打开注册页,填写用户名、邮箱与密码。
|
||||||
|
2. 若站点已配置邮件服务,可能需要邮箱验证码。
|
||||||
|
3. **第一个注册的用户会自动成为管理员**,无需额外安装向导。
|
||||||
|
|
||||||
|
登录后,右上角会出现头像与私信入口。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 2. 认识首页
|
||||||
|
|
||||||
|
首页通常是三栏布局:
|
||||||
|
|
||||||
|
| 区域 | 内容 |
|
||||||
|
| --- | --- |
|
||||||
|
| 左侧 | 板块导航、常用入口 |
|
||||||
|
| 中间 | 帖子列表(Feed) |
|
||||||
|
| 右侧 | 热门帖、最新评论等动态 |
|
||||||
|
|
||||||
|
中间列表可按 **最新发帖 / 最新回复 / 热门** 切换。
|
||||||
|
支持浅色 / 暗色主题,偏好会记住。
|
||||||
|
|
||||||
|
手机上侧栏会收起,不影响浏览与发帖。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 3. 发帖与回复
|
||||||
|
|
||||||
|
1. 点击「发帖」。
|
||||||
|
2. 选择板块,填写标题、标签(可选)与正文。
|
||||||
|
3. 正文支持富文本:分段、格式、图片上传等。
|
||||||
|
4. 发布后可在帖内回复;评论是 **楼层式** 的,可回复、引用、@。
|
||||||
|
|
||||||
|
帖子支持点赞与收藏。公开主页上可以看到你的基本资料与动态。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 4. 个人入口
|
||||||
|
|
||||||
|
点击头像菜单,常见入口包括:
|
||||||
|
|
||||||
|
- **个人主页**:别人看到的你
|
||||||
|
- **账号设置**:昵称、签名、头像、密码
|
||||||
|
- **站内私信**:与站内用户往来
|
||||||
|
- **我的收藏**:收藏过的帖子
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 5. 管理后台(仅管理员)
|
||||||
|
|
||||||
|
访问路径:`/admin`
|
||||||
|
|
||||||
|
常见能力:
|
||||||
|
|
||||||
|
- 板块、帖子、评论、举报、用户、媒体
|
||||||
|
- 系统设置(品牌、限流、敏感词、邮件、OIDC、存储等)
|
||||||
|
- 数据库备份
|
||||||
|
|
||||||
|
配置怎么分:
|
||||||
|
|
||||||
|
| 类型 | 在哪里改 |
|
||||||
|
| --- | --- |
|
||||||
|
| 端口、数据目录、JWT | 服务器上的 `app.ini`(改后重启) |
|
||||||
|
| OIDC、邮件、对象存储、品牌文案等 | 管理后台「系统设置」(保存即生效) |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 接下来做什么
|
||||||
|
|
||||||
|
1. 逛一遍现有板块
|
||||||
|
2. 发第一篇帖,或回一楼
|
||||||
|
3. 需要时再进后台微调站点设置
|
||||||
|
|
||||||
|
聊起来就对了。
|
||||||
89
docs/site-posts/03-features.md
Normal file
89
docs/site-posts/03-features.md
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
# 功能速览
|
||||||
|
|
||||||
|
> 建议标题:功能速览
|
||||||
|
> 建议标签:`站务` `功能`
|
||||||
|
> 建议操作:普通发布
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
姜十三论坛刻意把功能收在「小圈子真正用得到」的范围内。
|
||||||
|
下面按前台、互动、管理三块速览。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 前台浏览
|
||||||
|
|
||||||
|
- 三栏布局,桌面与移动端自适应
|
||||||
|
- Feed 排序:最新发帖 / 最新回复 / 热门
|
||||||
|
- 虚拟滚动,长列表也更流畅
|
||||||
|
- 浅色 / 暗色主题,偏好可记住
|
||||||
|
- 板块图标与主题色可自定义
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 发帖与讨论
|
||||||
|
|
||||||
|
- TipTap 富文本编辑器
|
||||||
|
- 标题、标签、板块选择
|
||||||
|
- 正文图片上传
|
||||||
|
- 楼层评论:回复、引用、@
|
||||||
|
- 点赞、收藏
|
||||||
|
- 帖子置顶、精华
|
||||||
|
- 编辑修订历史(可对比差异)
|
||||||
|
- 可配置普通用户的编辑时限
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 社交与个人
|
||||||
|
|
||||||
|
- 公开用户主页
|
||||||
|
- 站内私信(会话式)
|
||||||
|
- 账号资料:昵称、签名、头像
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 管理后台
|
||||||
|
|
||||||
|
统一在 `/admin`,与前台同一套 React 体验:
|
||||||
|
|
||||||
|
| 模块 | 能做什么 |
|
||||||
|
| --- | --- |
|
||||||
|
| 仪表盘 | 概览站点状态 |
|
||||||
|
| 板块 | 创建 / 编辑 / 排序 / 外观 |
|
||||||
|
| 帖子 | 审核、置顶、精华、锁定、回收站 |
|
||||||
|
| 评论 | 审核与管理 |
|
||||||
|
| 举报 | 处理用户举报 |
|
||||||
|
| 用户 | 禁言等管理操作 |
|
||||||
|
| 媒体 | 查看与清理上传文件 |
|
||||||
|
| 设置 | 品牌、限流、敏感词、邮件、OIDC、存储等 |
|
||||||
|
| 备份 | SQLite 一键备份 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 可选能力
|
||||||
|
|
||||||
|
这些不是「装完就必须开」的,按需在后台启用:
|
||||||
|
|
||||||
|
- 邮件验证码注册
|
||||||
|
- OIDC Provider(可给 Gitea 等站点做登录源)
|
||||||
|
- Gitea 公开仓库同步到「开源码桶」
|
||||||
|
- 本地磁盘或 S3 兼容对象存储
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 权限模型
|
||||||
|
|
||||||
|
只有两种角色:
|
||||||
|
|
||||||
|
- **普通用户**
|
||||||
|
- **管理员**
|
||||||
|
|
||||||
|
第一个注册用户自动成为管理员。
|
||||||
|
小圈子场景够用,不堆复杂角色矩阵。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 开发状态
|
||||||
|
|
||||||
|
项目仍在积极开发中,核心体验已经可用。
|
||||||
|
完整规划见仓库中的 `ROADMAP.md`。欢迎反馈与共建。
|
||||||
68
docs/site-posts/04-deployment.md
Normal file
68
docs/site-posts/04-deployment.md
Normal file
@@ -0,0 +1,68 @@
|
|||||||
|
# 为什么是单文件部署
|
||||||
|
|
||||||
|
> 建议标题:为什么是单文件部署
|
||||||
|
> 建议标签:`站务` `部署` `技术`
|
||||||
|
> 建议操作:按需发布(给关心自建的人看)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
姜十三论坛最硬核的卖点之一,是部署路径极短。
|
||||||
|
|
||||||
|
不是「理论上可以打包」,而是日常用法就是:
|
||||||
|
|
||||||
|
1. 编译得到一个二进制
|
||||||
|
2. 放到目录里运行
|
||||||
|
3. 自动生成 `app.ini`
|
||||||
|
4. 浏览器注册,第一个账号即管理员
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 它解决什么问题
|
||||||
|
|
||||||
|
传统论坛方案常常落在两端:
|
||||||
|
|
||||||
|
- **很重**:功能全,但部署与运维成本高
|
||||||
|
- **很碎**:聊天工具 / 文档工具方便,却缺少「发帖—回复—沉淀」的社区节奏
|
||||||
|
|
||||||
|
小圈子真正需要的往往是中间态:
|
||||||
|
|
||||||
|
- 有论坛结构,讨论可追溯
|
||||||
|
- 界面清爽,用起来顺手
|
||||||
|
- 部署简单到一个人能搞定
|
||||||
|
- 数据清楚、备份好懂
|
||||||
|
|
||||||
|
单文件部署,就是为最后两点服务的。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 具体意味着什么
|
||||||
|
|
||||||
|
| 能力 | 说明 |
|
||||||
|
| --- | --- |
|
||||||
|
| 单二进制 | 前端静态资源已内嵌,不必单独部署一套前端目录 |
|
||||||
|
| 内置 SQLite | 零外部数据库,数据落在本地目录 |
|
||||||
|
| 精简 `app.ini` | 主要管端口、数据目录、JWT 等进程级配置 |
|
||||||
|
| 后台热配置 | OIDC、邮件、存储、品牌等在管理后台修改,保存即生效 |
|
||||||
|
| 系统服务 | 内置 Linux systemd / Windows Service 安装与启停 |
|
||||||
|
| 跨平台 | Windows / Linux / macOS 均可编译与运行 |
|
||||||
|
|
||||||
|
备份也直观:数据目录里的数据库、上传文件、配置,结构清晰,拷贝即可留存。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 配置怎么分工
|
||||||
|
|
||||||
|
| 改什么 | 去哪里 |
|
||||||
|
| --- | --- |
|
||||||
|
| HTTP 端口、数据目录、JWT | `app.ini`(修改后重启进程 / 服务) |
|
||||||
|
| 站点品牌、OIDC、邮件、对象存储、限流、敏感词 | 管理后台 → 系统设置 |
|
||||||
|
|
||||||
|
这样既保留「改文件就能控进程」的可控性,又避免把所有业务项都塞进配置文件。
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 一句话总结
|
||||||
|
|
||||||
|
**姜十三论坛** = 小圈子该有的论坛能力 × 清新好用的界面 × 真正能单文件带走的部署方式。
|
||||||
|
|
||||||
|
源码与说明见项目仓库。许可证:MIT。
|
||||||
29
docs/site-posts/README.md
Normal file
29
docs/site-posts/README.md
Normal file
@@ -0,0 +1,29 @@
|
|||||||
|
# 站务公告 · 发帖素材
|
||||||
|
|
||||||
|
本目录提供「站务公告」板块的建板参数,以及可直接复制到论坛的介绍文章(Markdown)。
|
||||||
|
|
||||||
|
## 板块设置
|
||||||
|
|
||||||
|
| 项 | 建议值 |
|
||||||
|
| --- | --- |
|
||||||
|
| 名称 | 站务公告 |
|
||||||
|
| 描述 | 本站说明与姜十三论坛介绍。请勿灌水。 |
|
||||||
|
| 图标 | `megaphone` |
|
||||||
|
| 色标 | 建议第 0 或 1 槽(稳重、好辨认) |
|
||||||
|
| 排序 | `0`(尽量靠前) |
|
||||||
|
|
||||||
|
## 文章与标签
|
||||||
|
|
||||||
|
| 文件 | 建议标题 | 标签 | 操作 |
|
||||||
|
| --- | --- | --- | --- |
|
||||||
|
| [01-welcome.md](./01-welcome.md) | 欢迎来到本站 | `站务` `介绍` | **置顶**(可选精华) |
|
||||||
|
| [02-getting-started.md](./02-getting-started.md) | 三分钟上手本站 | `站务` `指南` | 普通发布 |
|
||||||
|
| [03-features.md](./03-features.md) | 功能速览 | `站务` `功能` | 普通发布 |
|
||||||
|
| [04-deployment.md](./04-deployment.md) | 为什么是单文件部署 | `站务` `部署` `技术` | 按需发布 |
|
||||||
|
|
||||||
|
## 发布建议
|
||||||
|
|
||||||
|
1. 先建板块,再按上表顺序发帖。
|
||||||
|
2. 每篇复制「标题 / 标签 / 正文」三块;正文从 `---` 后的正文区开始粘贴。
|
||||||
|
3. 若编辑器是富文本:粘贴后检查标题层级与列表是否正常。
|
||||||
|
4. 本板块仅发站务与介绍;日常讨论放到其他板块。
|
||||||
Reference in New Issue
Block a user