# GooseForum

**Repository Path**: andy-w/GooseForum

## Basic Information

- **Project Name**: GooseForum
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-10
- **Last Updated**: 2026-09-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <img src="resource/static/pic/icon_300.webp?t=1788958424" width="140"/>
  <h1>GooseForum</h1>
  <p>让交流发生，让内容沉淀，让社区成长。</p>

  <p>
    <a href="https://github.com/leancodebox/GooseForum/releases"><img src="https://img.shields.io/github/release/leancodebox/GooseForum.svg" alt="GitHub release"></a>
    <a href="https://github.com/avelino/awesome-go"><img src="https://awesome.re/mentioned-badge-flat.svg" alt="Mentioned in Awesome Go"></a>
    <a href="https://golang.org"><img src="https://img.shields.io/badge/Go-1.26+-blue.svg" alt="Go version"></a>
    <a href="https://tailwindcss.com"><img src="https://img.shields.io/badge/TailwindCSS-4-blue.svg" alt="TailwindCSS"></a>
    <a href="LICENSE"><img src="https://img.shields.io/github/license/leancodebox/GooseForum.svg" alt="License"></a>
    <a href="https://github.com/leancodebox/GooseForum/stargazers"><img src="https://img.shields.io/github/stars/leancodebox/GooseForum.svg?style=social" alt="GitHub stars"></a>
  </p>

  <p><a href="README_ZH.md">中文</a> | <a href="README.md">English</a></p>
</div>

![GooseForum 界面预览](https://github.com/leancodebox/assert/blob/main/gooseforum-readme-poster.webp?raw=true)

GooseForum 是一个开源论坛，为社区提供讨论、分享与持续交流的空间。从发布第一篇主题，到管理内容、成员和社区风格，你可以在自己的服务器上建立并运营社区。

[在线体验](https://gooseforum.online/) · [下载最新版本](https://github.com/leancodebox/GooseForum/releases)

## 核心特性

- **围绕内容展开讨论**：Markdown 主题、回复、分类和草稿，让分享与讨论有序展开。
- **保持社区联系**：通知、私信和用户主页，让交流延续到主题之外。
- **掌握社区运营**：内置管理后台，支持角色和权限管理。
- **打造自己的社区风格**：自定义 Logo、品牌文案和页脚，通过主题工作台预览并发布浅色、深色主题。
- **随时参与交流**：适配桌面与移动端，支持流畅的站内导航，并保留无 JavaScript 时可访问的页面。
- **自主部署与维护**：单个可执行文件，默认 SQLite，可选 MySQL 或 PostgreSQL，支持 SQLite 定时备份。

## 快速开始

### 下载并启动

从 [GitHub Releases](https://github.com/leancodebox/GooseForum/releases) 下载最新预编译版本，然后启动：

```bash
tar -zxvf GooseForum_Linux_x86_64.tar.gz
chmod +x ./GooseForum
./GooseForum serve
```

访问 `http://localhost:5234`。第一个注册用户会自动成为管理员。

### 从源码构建

环境要求：

- Go 1.27+
- Node.js 18+
- pnpm

```bash
git clone https://github.com/leancodebox/GooseForum.git
cd GooseForum

cd resource && pnpm install && pnpm build && cd ..
go mod tidy
go build -ldflags="-w -s" .

./GooseForum serve
```

### 配置

GooseForum 首次启动会自动创建 `config.toml`，默认使用 SQLite。

```toml
[app]
env = "production"

[server]
port = 5234
url = "http://localhost"

[db.default]
connection = "sqlite"
path = "./storage/database/sqlite.db"
```

MySQL/PostgreSQL、邮件、备份、安全和站点配置见 [配置文档](docs/configuration_ZH.md)。

### 管理命令

```bash
./GooseForum migrate
./GooseForum set-user-admin <用户ID>
./GooseForum set-user-email <用户ID> <邮箱>
./GooseForum set-user-password <用户ID> <密码>
```

## 开发

后端使用 Go、Gin 和 GORM，前端使用 React 19、TypeScript、Vite 和 TailwindCSS。站内导航由服务端 payload 驱动，同时保留面向 SEO 和无 JavaScript 访问的 GoHTML 页面。

```bash
# 后端热重载
air

# 主站和管理后台前端
cd resource && pnpm dev
```

管理后台由独立 React 入口提供，访问路径为 `/admin`，不需要单独启动管理端前端服务。

## 项目结构

```text
GooseForum/
├── app/                    # 后端代码
│   ├── console/            # CLI 命令
│   ├── http/               # 控制器、中间件、路由
│   ├── models/             # GORM 模型
│   └── service/            # 业务服务
├── resource/               # React 19 前端、模板和静态资源
│   ├── src/site/           # 主站
│   ├── src/admin/          # 管理后台
│   ├── src/runtime/        # Payload 运行时和共享浏览器工具
│   └── templates/          # GoHTML 降级模板
├── docs/                   # 配置文档
├── main.go
└── config.toml
```

## 部署建议

生产环境建议放在 Nginx 或 Caddy 等反向代理后，开启 HTTPS，并配置数据库备份。

最小容器镜像示例：

```dockerfile
FROM alpine:latest
RUN apk --no-cache add ca-certificates
WORKDIR /root/
COPY GooseForum .
CMD ["./GooseForum", "serve"]
```

## 文档

- [配置文档](docs/configuration_ZH.md)

## 许可证

MIT License，见 [LICENSE](LICENSE)。