NanamiAdmin
5e9bdf02f9
- Add `getSystemdServiceName` function to get systemd service name. - When detected as systemd sevice, use `systemctl restart` to restart the program then exit.
83 lines
2.3 KiB
Markdown
83 lines
2.3 KiB
Markdown
# 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.
|
|
|
|
## Supported Platforms
|
|
|
|
- `GNU/Linux`
|
|
- `Windows`
|
|
|
|
## Basic Configuration
|
|
|
|
Create a `config.json` file in the project root:
|
|
|
|
```json
|
|
{
|
|
"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
|
|
|
|
**You have to put the compiled frontend in the `web/dist` directory before building the backend.**
|
|
|
|
```bash
|
|
go build -o super-frpc.exe
|
|
```
|
|
|
|
For Linux:
|
|
|
|
```bash
|
|
GOOS=linux GOARCH=amd64 go build -o super-frpc
|
|
```
|
|
|
|
## Run
|
|
|
|
```bash
|
|
./super-frpc
|
|
```
|
|
|
|
## API Documentation
|
|
|
|
For detailed API documentation, please see [docs/api.md](docs/api.md)
|
|
|
|
## TODO
|
|
|
|
- [x] Add Windows boot service support
|
|
- [x] Add session list API
|
|
- [x] Add session management API
|
|
- [x] Add user config modify API
|
|
- [x] Add user type modify API
|
|
- [x] Add frpc instance running status management API
|
|
- [x] Add frpc instance log display API
|
|
- [x] Fix random database lock when processing logs
|
|
- [ ] Add frpc createdBy display
|
|
- [x] Add frpc proxy management API
|
|
- [x] Fix backend can still start frpc instance when it is already running
|
|
- [ ] Develop an agent software to handle windows service management
|
|
- [ ] Refactor all log output level to be more clear
|
|
- [x] Add frpc instance watchdog
|
|
- [ ] Add per-proxy status display
|
|
- [ ] Add proxy edit submit action
|
|
- [ ] Add per-proxy status control
|
|
- [x] Fix reboot failed when deployed as systemd service
|
|
- [x] Enhance speed of listing instances
|
|
- [x] Increase speed of fetching instance logs
|
|
- [x] Refactor systemd service log output method to local file
|
|
- [ ] Fix no log output in instanceDetail view
|
|
- [ ] Add update frp binary function
|
|
|
|
## License
|
|
|
|
GPL-3.0
|