-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
SturdyFool10
authored
Dec 11, 2023
1 parent
239e2ca
commit b033656
Showing
1 changed file
with
53 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,53 @@ | ||
| # RustServerController | ||
|
|
||
| ## Project Status: | ||
| ### main: [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_win.yml) [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_linux.yml) [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_MacOS.yml) | ||
| ### testing: [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_win_testing.yml) [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_linux_testing.yml) [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_MacOS_testing.yml) | ||
| This server software is for the easy control of servers deployed on another machine, using as little by way of resources as it can, you should not notice it in all but the most resource limited of scenarios | ||
| ## How to build: | ||
| To get started, you can go two routes: | ||
| ### Build and compile from scratch: | ||
| in order to allow you to compile this project, clone the main branch, then go into the root directory(it should look the same as the github repo from the main branch in there), from there, you want to get your terminal and run the command: | ||
| ```bash | ||
| cargo build --release | ||
| ``` | ||
| once the build is complete, you should be able to find your compiled executable as /target/release/server_host.exe, its standalone so move it where you please! | ||
| Please note that you will need to go to <a href="http://rustup.rs">rustup</a> in order to get cargo installed and you may want git as well for easy cloning of the repo. | ||
| ### go to the releases tab for official stable and complete builds | ||
| I will be updating and posting pre-compiled executables to the repo, these are less secure for someone who does know rust, since I will likely not be distributing source code with the executable versions, but will require much less technical expertise and resources | ||
| # Masters and Slaves | ||
| with a new feature recently added, this is *in theory* ready for a more clustered setup, allowing for the configuration of masters and slaves | ||
| ## Configuring a node to become a slave: | ||
| A server becomes a slave when the slave line in the configuration is set to true, being a slave has two main meanings: that the node may not have any slaves and will not attempt to make connections to configured slaves, and that the node will not host a webui. | ||
| ## Configuring a master to connect to a slave: | ||
| On windows use the ipconfig command to get the ipv4 address of your slave node's host PC, in the config paste this template and fill in the values, the ipv4 address goes into the address field: | ||
| ```json | ||
| { | ||
| "address": "<your address here>", | ||
| "port": "<slave's port here>" | ||
| } | ||
| ``` | ||
|
|
||
| # RustServerController Documentation | ||
|
|
||
| ## Current Project Status: | ||
| ### Main Branch: | ||
| - Windows Build Status: [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_win.yml) | ||
| - Linux Build Status: [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_linux.yml) | ||
| - MacOS Build Status: [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_MacOS.yml) | ||
|
|
||
| ### Testing Branch: | ||
| - Windows Testing Build Status: [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_win_testing.yml) | ||
| - Linux Testing Build Status: [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_linux_testing.yml) | ||
| - MacOS Testing Build Status: [](https://github.com/SturdyFool10/RustServerController/actions/workflows/build_MacOS_testing.yml) | ||
|
|
||
| RustServerController is designed for seamless server management on remote machines, with minimal resource usage, ensuring it remains unobtrusive in most scenarios. | ||
|
|
||
| ## Building the Project: | ||
| You can start building in two ways: | ||
|
|
||
| ### Building from Source: | ||
| - Clone the main branch of the repository. | ||
| - Navigate to the root directory, which mirrors the structure of the GitHub repository's main branch. | ||
| - Open your terminal and execute the following command: | ||
| ```bash | ||
| cargo build --release | ||
| ``` | ||
| - Once built, the compiled executable can be found at `/target/release/server_host.exe`. This file is standalone and can be moved as needed. | ||
| - Note: Ensure that you have installed Cargo from [rustup.rs](http://rustup.rs). Git might also be required for cloning the repository. | ||
|
|
||
| ### Using Pre-Compiled Executables: | ||
| - Pre-compiled executables are regularly updated and posted in the repository's releases tab. | ||
| - These executables are less secure for those familiar with Rust, as source code may not always be provided, but they are easier to use and require less technical knowledge. | ||
| # Master-Slave Architecture | ||
| The recent addition of a new feature enables a clustered setup with master and slave configurations. | ||
| ## Configuring a Slave Node: | ||
| - A server is designated as a slave by setting the 'slave' line to true in its configuration. | ||
| - Being a slave means the node will neither have slaves nor attempt to connect to configured slaves, and it will not host a web UI. | ||
| ## Configuring a Master to Connect to a Slave: | ||
| - On Windows, use the `ipconfig` command to obtain the IPv4 address of the slave node's host PC. | ||
| - Edit the configuration using the following template, inserting the slave's IPv4 address and port: | ||
| ```json | ||
| { | ||
| "address": "<your address here>", | ||
| "port": "<slave's port here>" | ||
| } | ||
| ``` | ||
| ### Additional Information: | ||
| - To edit a slave's configuration, use an external text editor (Notepad++ recommended). | ||
| - While chaining master nodes is possible, it is not recommended due to potential latency issues. Support is not provided for setups with more than one layer of indirection. Assistance requests for multi-indirection setups will be the user's responsibility. |