refactor(README): update configuration instructions and remove outdated features section
This commit is contained in:
@@ -2,20 +2,12 @@
|
|||||||
|
|
||||||
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.
|
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
|
|
||||||
|
|
||||||
## Supported Platforms
|
## Supported Platforms
|
||||||
|
|
||||||
- `GNU/Linux`
|
- `GNU/Linux`
|
||||||
- `Windows`
|
- `Windows`
|
||||||
|
|
||||||
## Configuration
|
## Basic Configuration
|
||||||
|
|
||||||
Create a `config.json` file in the project root:
|
Create a `config.json` file in the project root:
|
||||||
|
|
||||||
@@ -52,7 +44,7 @@ GOOS=linux GOARCH=amd64 go build -o super-frpc
|
|||||||
## Run
|
## Run
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./super-frpc -config ./config.json -db ./database.db
|
./super-frpc
|
||||||
```
|
```
|
||||||
|
|
||||||
## API Documentation
|
## API Documentation
|
||||||
@@ -75,6 +67,9 @@ For detailed API documentation, please see [docs/api.md](docs/api.md)
|
|||||||
- [ ] Develop an agent software to handle windows service management
|
- [ ] Develop an agent software to handle windows service management
|
||||||
- [ ] Refactor all log output level to be more clear
|
- [ ] Refactor all log output level to be more clear
|
||||||
- [x] Add frpc instance watchdog
|
- [x] Add frpc instance watchdog
|
||||||
|
- [ ] Add per-proxy status display
|
||||||
|
- [ ] Add proxy edit submit action
|
||||||
|
- [ ] Add per-proxy status control
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user