GETTING STARTED

让你的社区,正式上线。

从一个文件开始,完成初始化,再把你的站点分享给更多人。

01 / 准备与下载

准备一台 Windows x64 或 Linux x64 电脑或服务器,并为 GForm 创建独立目录。默认模式下,前端、SQLite 数据库和文件存储都由主程序提供。

两个下载入口均前往飞书文件夹,请选择与你的系统对应的主程序。

请先在本机或受限网络中完成管理员初始化,再将站点开放给外部访问。运行目录需要有写入权限。

02 / 启动程序

Windows

将主程序放进独立目录,在该目录打开 PowerShell,执行:

.\gblox-server-windows-amd64.exe

Linux

将主程序放进独立目录,赋予执行权限后启动:

chmod +x gblox-server-linux-amd64
./gblox-server-linux-amd64

默认在端口 8080 提供服务。在本机浏览器打开 http://127.0.0.1:8080,进入初始化向导。端口被占用时,可通过 -p 参数指定其他端口:

# Linux 示例
./gblox-server-linux-amd64 -p 8114

# Windows 示例
.\gblox-server-windows-amd64.exe -p 8114

首次启动会自动生成 config.yml、释放前端资源与离线 IP 数据库,并建立业务数据库。保持终端运行;关闭进程会停止服务。

03 / 完成五步初始化

  1. 欢迎:了解产品,开始配置。
  2. 数据库:默认使用 SQLite;已有 MySQL 时,也可填写连接信息并测试。
  3. 存储:选择内置存储,或配置独立存储服务。
  4. 站点:设置社区名称、Logo 等站点信息。
  5. 管理员:创建第一个管理员账号,完成初始化。

初始化完成后,进入管理后台创建内容分区、设置公告,再发布第一篇帖子或第一个资源。

04 / 配置域名与持续运行

正式上线时,将域名解析到服务器,并使用 Nginx 等反向代理提供 HTTPS。反向代理指向 GForm 的本机监听端口,文件上传所需的请求体大小也应按实际需求配置。

# 放在已配置 HTTPS 的 Nginx server 块中
location / {
    proxy_pass http://127.0.0.1:8080;
    proxy_set_header Host $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;
}

在后台检查站点地址与存储公开地址,使其与正式访问域名一致。若所有流量都经过反向代理,可限制源站端口的外部访问。

Linux 作为系统服务运行

使用专门的普通用户运行,确保该用户可以读写安装目录。下面以已创建的 gform 用户与 /opt/gform 目录为例,将配置保存为 /etc/systemd/system/gform.service:

[Unit]
Description=GForm Community
After=network.target

[Service]
Type=simple
User=gform
WorkingDirectory=/opt/gform
ExecStart=/opt/gform/gblox-server-linux-amd64
Restart=on-failure
RestartSec=3

[Install]
WantedBy=multi-user.target
sudo systemctl daemon-reload
sudo systemctl enable --now gform
sudo journalctl -u gform -f

Windows 可使用任务计划程序,或服务管理工具配置开机启动。将工作目录设置为 GForm 主程序所在目录。

05 / 备份、更新与迁移

先备份,再更新

停止服务后,备份 config.yml、数据库和上传文件,再替换主程序并重启。默认部署中,数据库与上传文件位于 data/;若自定义了目录,请以实际配置为准。

使用方式需要备份的内容
默认 SQLite + 内置存储config.yml 与 data/,以及自定义的数据目录
MySQL配置文件、MySQL 数据库备份及上传文件
独立存储 / 对象存储主站配置、业务数据库、存储服务配置与文件或存储桶数据

配置文件含站点密钥,应保存在受限位置。升级后验证登录、内容、上传与下载正常,再恢复对外服务。

高级版授权与迁移

高级版授权与服务器设备号绑定。换服务器、变更网卡或重建容器后,设备号可能改变,需联系发行方重新签发授权。迁移前请先联系工作室确认。

高级版授权到期后会回落到标准版,数据保留;有效授权恢复后,相关高级功能重新可用。

06 / 随着社区成长扩展

默认的单程序部署适合起步。需要更灵活的架构时,可按需选择:

  • MySQL:改用独立数据库服务。
  • 前后端分离:前端静态资源交给 Nginx 或 CDN 托管。
  • 存储独立:将文件存储放到单独的进程或服务器。
  • S3 兼容对象存储:按实际需求使用对象存储桶。

这些是可选的部署方式,不需要在第一次搭建时全部配置。

需要协助?发送邮件至 [email protected],说明系统平台、部署方式与遇到的问题。分享日志前请移除密码、密钥与令牌。

下载 GForm,开始你的社区 ↗