search

RCVolus / league-prod-toolkit

Toolkit for League Productions with overlays for champion select, ingame events, end of game stats, and more
MIT License
137 stars 25 forks source link

[ Update Docs ] Update the Installation.md on Wiki to contain install guide for Docker Image. #278

Open Coow opened 1 year ago

Coow commented 1 year ago

Install Prod-Toolkit with Docker

  1. Run docker run -d --name='LeagueProdToolkit' -p '3003:3003' -v LPT:'/app/modules' 'eirikskarding/leagueprodtoolkit:latest'
  2. Wait for DataDragon download and unpacking to finish.
  3. Connect via <hostIP>:3003

By default every module is installed from the Docker Image. If you want to remove some of the modules, you can delete the folders in the Docker Volume "LPT""

To edit the configuration file, edit the config.json file in the "plugin-config" module. By default it's avaliable in the Docker Volume here: /var/lib/docker/volumes/LPT/_data/plugin-config/config.json Here you can change the server region (EUW1 by default). And you can add your Riot Games API Key. These steps are normally setup when running install.bat.

If you would like to enable authentication if you want to expose the container to the internet.

  1. Run docker exec -it LeagueProdToolkit sh in your terminal.
  2. In the Docker Container, run node /app/dist/scripts/auth.js
  3. Press "y" to enable or "n" to disable and then Enter.
  4. Exit the container by running exit
  5. Restart the Docker Container by running: docker restart LeagueProdToolkit
  6. Run docker logs LeagueProdToolkitThe logs should display the key needed to log into the Web GUI
  7. Refresh the Web GUI and enter your API Key.
sdomi4 commented 1 year ago

Thanks for the suggestion/creating the image and the docs :) We're looking into automatically generating an up to date docker image for each release version, we'll update the docs accordingly when ready.