0f3bf18fc196c92e377d40f8515656d8cb8fccd4
Restructure documentation by moving API details from README.md to docs/api.md Update README.md to reference the new API documentation location
Super-frpc
A backend application for managing local frpc instances, allowing users to easily start, stop, restart, and perform daily maintenance operations on frpc instances. It also provides automated error handling, such as automatic restart when an instance crashes.
Features
- User authentication with token-based login
- Create, delete, and modify frpc instances
- Automatic startup configuration (systemd/init.d)
- User permission management (superuser/admin/visitor)
- SQLite database for data persistence
Configuration
Create a config.json file in the project root:
{
"listenAddr": "0.0.0.0",
"listenPort": "8080",
"frpcPath": "/usr/bin/frpc",
"instancePath": "./configs"
}
| Field | Description | Default |
|---|---|---|
| listenAddr | Server listening address | 0.0.0.0 |
| listenPort | Server listening port | 8080 |
| frpcPath | Path to frpc executable | /usr/bin/frpc |
| instancePath | Path to store instance config files | ./configs |
Build
go build -o super-frpc
For Linux:
GOOS=linux GOARCH=amd64 go build -o super-frpc
Run
./super-frpc -config ./config.json -db ./database.db
API Documentation
For detailed API documentation, please see docs/api.md
License
GPL-3.0
Languages
Go
100%