README
¶
FeatherWings
Wings is featherpanel's server control plane, built for the rapidly changing gaming industry and designed to be highly performant and secure. Wings provides an HTTP API allowing you to interface directly with running server instances, fetch server logs, generate backups, and control all aspects of the server lifecycle.
In addition, Wings ships with a built-in SFTP server allowing your system to remain free of FeatherPanel specific dependencies, and allowing users to authenticate with the same credentials they would normally use to access the Panel.
API Documentation
Swagger/OpenAPI documentation is generated from inline annotations under router/.
export PATH="$(go env GOPATH)/bin:$PATH" # In some distors you might need this
go install github.com/swaggo/swag/cmd/swag@latest
go generate ./router
The daemon serves the generated spec at /api/docs/openapi.json, and provides an interactive Swagger UI at /api/docs/ui whenever api.docs.enabled is true in config.yml.
Reporting Issues
Feel free to report any wings specific issues or feature requests in GitHub Issues.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
docs
|
|
|
swagger
Package swagger Code generated by swaggo/swag.
|
Package swagger Code generated by swaggo/swag. |
|
internal
|
|
|
ufs
Package ufs provides an abstraction layer for performing I/O on filesystems.
|
Package ufs provides an abstraction layer for performing I/O on filesystems. |
|
loggers
|
|
|
transfer
Package transfer handles all logic related to transferring servers between two nodes.
|
Package transfer handles all logic related to transferring servers between two nodes. |