server-manager/backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
ACoolName 2025-05-19 16:32:39 +03:00
parent af0a463d83
commit 032afc810c
1 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,15 +1,18 @@
# Server Manager Kubernetes Operator
# Server Manager Backend
This is the code for the back-end used in [ServerManager](https://games.acooldomain.co). This is the code for the back-end used in [ServerManager](https://games.acooldomain.co).
The server-manager is designed with modularity in mind and is built from a few major parts. The server-manager is designed with modularity in mind and is built from a few major parts.
1. Users <!--toc:start-->
2. Servers Metadata - [User Management](#user-management)
3. Servers Authorization Data - [Servers Metadata](#servers-metadata)
4. Instance Manager - [Servers Authorization](#servers-authorization)
- [Instance Manager](#instance-manager)
The backend interfaces with these parts separately however it will share connections where possible to reduce duplicate connections. The backend interfaces with these parts separately however it will share the module's internal connection where possible to reduce duplicate connections.
For example if several modules use the same mongo connection there is no reason to create several connections to the database.
# Modules # Modules
@ -17,12 +20,12 @@ The backend interfaces with these parts separately however it will share connect
The User management module has several responsibilities and should be split into modules in the future. The User management module has several responsibilities and should be split into modules in the future.
* Fetch and save data about existing users - Fetch and save data about existing users
* Global Permissions - Global Permissions
* Nickname - Nickname
* Contact Email - Contact Email
* Authenticate a user - Authenticate a user
Currently the User Management is only implemented with MongoDB as the underlying database Currently the User Management is only implemented with MongoDB as the underlying database
@ -30,10 +33,10 @@ Currently the User Management is only implemented with MongoDB as the underlying
The Servers Metadata holds data about existing servers such as: The Servers Metadata holds data about existing servers such as:
* Default command to run when ran without arguments - Default command to run when ran without arguments
* Default ports to open in case no ports are opened - Default ports to open in case no ports are opened
* Server nickname - Server nickname
* Data on the image the server uses - Data on the image the server uses
Currently only implemented with MongoDB Currently only implemented with MongoDB
@ -47,7 +50,7 @@ Currently only implemented with MongoDB
The Instance Manager is responsible for running the servers, and supplying interactive shell to the console of the server. The Instance Manager is responsible for running the servers, and supplying interactive shell to the console of the server.
Currently implemented in Docker, and Kubernetes (using the [ServerManager Operator](https://git.acooldomain.co/server-manager/kubernetes-operator)) Can currently manage servers in Docker, and Kubernetes (using the [ServerManager Operator](https://git.acooldomain.co/server-manager/kubernetes-operator))
## Configuration Example ## Configuration Example