Update README.md
This commit is contained in:
parent
ae44bb4aeb
commit
c5d14213b4
20
README.md
20
README.md
|
@ -9,16 +9,32 @@ Windows:
|
|||
Linux:
|
||||
`dotnet publish -r linux-x64 -c Release KamihamaWeb`
|
||||
|
||||
## Config options
|
||||
- `Proxy`: Leave empty or specify a HTTP proxy
|
||||
- `MaxThreads`: Specify to client how many concurrent downloads can take place (higher number = more server load)
|
||||
- `Version`: Minimum client version in client's `Config.h` to connect to this server (or an error will be shown to the user)
|
||||
- `Type`: `master` or `replica` server (see load balancing)
|
||||
|
||||
### Load balancing
|
||||
If you use Cloudflare and have the CF-IPCountry header set with a GeoIP country code you can load balance by specifying alternate endpoints, where the correct endpoint will be sent to the user on login:
|
||||
```
|
||||
"MagiRecoNodes": {
|
||||
"US": "https://us-endpoint.rayshift.io/game",
|
||||
"*": "https://global-endpoint.rayshift.io/game"
|
||||
}
|
||||
```
|
||||
If the country code isn't found in the config file, the default (`*`) will be used.
|
||||
|
||||
## Usage
|
||||
- Edit the configuration file appsettings(.Development).json using the example given in appsettings.Example.json
|
||||
- Create a directory `MagiaRecoStatic/` in the binaries' working directory.
|
||||
- Clone https://git.rayshift.io/kamihama/magia-assets.git or your own assets into this directory `git clone URL`.
|
||||
- Run the server, either directly `./KamihamaWeb`, or through a systemd service:
|
||||
|
||||
/etc/systemd/system/kestrel-kamihama-prod.service
|
||||
- /etc/systemd/system/kestrel-kamihama-prod.service
|
||||
```
|
||||
[Unit]
|
||||
Description=Rayshift
|
||||
Description=Kamihama Server
|
||||
|
||||
[Service]
|
||||
WorkingDirectory=/home/rayshift/KamihamaWeb/
|
||||
|
|
Loading…
Reference in New Issue