diff --git a/README.md b/README.md index 2fc9872..5da2ecf 100644 --- a/README.md +++ b/README.md @@ -4,51 +4,29 @@ Unlike [Swirlix](https://github.com/UnownHash/Swirlix-Public), Xilriws doesn't u This has the advantage of being free and not requiring an account, but might result in some issues unique to your system. As such, a docker installation is highly recommended, even if the rest of your setup isn't dockerized. -## Docker installation (recommended) +## Installation -1. `git clone https://github.com/UnownHash/Xilriws-Public` -2. `cp docker-compose.yml.example docker-compose.yml` -3. - -run `./run.sh` to download the xilriws binary and config file - -build the Docker image with `docker build -t xilriws .` - -copy the docker-compose config to your existing docker-compose file for the unown# stack, or on its own. -if you have it on its own, you will need to make sure to uncomment the port mapping lines in the compose file. -keep in mind there is no authentication on this, so avoid exposing it to the public internet if possible. - -you can change the "replicas" number to alter how many copies of the container will be spawned. traefik manages load balancing, -and should work automatically. set this number in accordance with the avaliable RAM and CPU on your machine. - -the more copies of the container, the lower you can set login delay - -copy `config.json` somewhere into the path of wherever your docker-compose file is, and name it whatever you'd like. -the example docker-compose assumes it's named `xilriws.json`, and in the same directory as the docker-compose file. -update the `volumes` section in the docker-compose to match the file name and path of the new config file - -start the container with `docker-compose up -d` +1. `git clone https://github.com/UnownHash/Xilriws-Public Xilriws && cd Xilriws` +2. `cp docker-compose.yml.example docker-compose.yml && cp xilriws.json.example xilriws.json` +3. `docker compose up -d` in your Dragonite config, add: ```toml [general] -remote_auth_url = "http://xilriws:/api/v1/login-code" +remote_auth_url = "http://xilriws:5090/api/v1/login-code" ``` -this assumes you have everything in the same docker network. if you're hosting it externally, change the `xilriws` hostname to +this assumes you have everything in the same docker network. if you're hosting it externally, change the hostname to something else accordingly. +### Update -## Manual installation (not recommended) - -Note that this has to be run without root. - -run `./run.sh` +1. `git pull` +2. `docker compose pull` +3. `docker compose restart` -edit config.json as you need - -you need chromedriver installed, and it needs to be in your `PATH`. -The easiest way to do this on ubuntu-like operating systems is `sudo apt install chromium-driver`. +you can change the "replicas" number to alter how many copies of the container will be spawned. traefik manages load balancing, +and should work automatically. set this number in accordance with the avaliable RAM and CPU on your machine. -run `./xilriws` to start the service +the more copies of the container, the lower you can set login delay diff --git a/xilriws b/xilriws index bd37317..32d463b 100755 Binary files a/xilriws and b/xilriws differ