Service Deployment

This document follows the current all-in-one deployment mode: one bbs-go process serves site, admin, and API.

1. Prerequisites

• Database:
  • MySQL 8+ recommended for production
  • SQLite available for local trial

2. Get and Prepare

Using release packages is recommended:

1. Download the package for your platform from Releases
2. Extract package
3. In the extracted directory, ensure bbs-go, site/, admin/, res/, and locales/ exist

3. Start Service

Run in release package directory:

# Linux/macOS
./bbs-go

# Windows
bbs-go.exe

Default port: 8082.

4. First-Time Installation

When not installed, open:

http://<host>:8082/install

The installer supports:

• Language: en-US / zh-CN
• Database: MySQL / SQLite
• Site info and admin account initialization

After success, bbs-go.yaml is written automatically and migrations are initialized.

5. Endpoints

• Site: http://<host>:8082/
• Admin: http://<host>:8082/admin
• API: http://<host>:8082/api/*

6. Production Recommendations

• Use MySQL in production
• Put Nginx/Caddy in front for HTTPS
• Backup database and uploaded assets regularly
• Use systemd/supervisor/container platform to manage process lifecycle

7. Troubleshooting

Port already in use

Change Port in bbs-go.yaml or free the occupied port.

Cannot access installer

Make sure the service is running and open /install; installed instances redirect to /.

SQLite notes

SQLite is good for local trial/small usage; MySQL is recommended for production.

8. Related Docs

• Google Login Configuration