Update README.md
This commit is contained in:
parent
12b2bd7985
commit
bac8dc6a3e
10
README.md
10
README.md
|
@ -2,20 +2,20 @@
|
||||||
|
|
||||||
Custom server for serving localized assets for Magia Record to be used in conjunction with https://github.com/rayshift/magiatranslate.
|
Custom server for serving localized assets for Magia Record to be used in conjunction with https://github.com/rayshift/magiatranslate.
|
||||||
|
|
||||||
## Build Instructions
|
### Build Instructions
|
||||||
Windows:
|
Windows:
|
||||||
`dotnet publish -c Release KamihamaWeb`
|
`dotnet publish -c Release KamihamaWeb`
|
||||||
|
|
||||||
Linux:
|
Linux:
|
||||||
`dotnet publish -r linux-x64 -c Release KamihamaWeb`
|
`dotnet publish -r linux-x64 -c Release KamihamaWeb`
|
||||||
|
|
||||||
## Config options
|
### Config options
|
||||||
- `Proxy`: Leave empty or specify a HTTP proxy
|
- `Proxy`: Leave empty or specify a HTTP proxy
|
||||||
- `MaxThreads`: Specify to client how many concurrent downloads can take place (higher number = more server load)
|
- `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)
|
- `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)
|
- `Type`: `master` or `replica` server (see load balancing)
|
||||||
|
|
||||||
### 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:
|
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": {
|
"MagiRecoNodes": {
|
||||||
|
@ -25,7 +25,7 @@ If you use Cloudflare and have the CF-IPCountry header set with a GeoIP country
|
||||||
```
|
```
|
||||||
If the country code isn't found in the config file, the default (`*`) will be used.
|
If the country code isn't found in the config file, the default (`*`) will be used.
|
||||||
|
|
||||||
## Usage
|
### Usage
|
||||||
- Edit the configuration file appsettings(.Development).json using the example given in appsettings.Example.json
|
- Edit the configuration file appsettings(.Development).json using the example given in appsettings.Example.json
|
||||||
- Create a directory `MagiaRecoStatic/` in the binaries' working directory.
|
- 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`.
|
- Clone https://git.rayshift.io/kamihama/magia-assets.git or your own assets into this directory `git clone URL`.
|
||||||
|
@ -60,5 +60,5 @@ cd /home/rayshift/KamihamaWeb
|
||||||
cd MagiRecoStatic/ && git pull --rebase origin master && cd .. && rm en_cache.json && sudo systemctl restart kestrel-kamihama-prod.service
|
cd MagiRecoStatic/ && git pull --rebase origin master && cd .. && rm en_cache.json && sudo systemctl restart kestrel-kamihama-prod.service
|
||||||
```
|
```
|
||||||
|
|
||||||
## Contributing
|
### Contributing
|
||||||
Contributions are strongly encouraged as this server implementation will not receive further updates by its creator. Please create a pull request with your changes.
|
Contributions are strongly encouraged as this server implementation will not receive further updates by its creator. Please create a pull request with your changes.
|
||||||
|
|
Loading…
Reference in New Issue