Tha_14/uam-docker
1
0
Fork 0
mirror of https://github.com/Tha14/uam-docker.git synced 2024-12-27 07:33:24 +01:00
Code Issues Packages Projects Releases Wiki Activity
A docker compose script for running UAM in a docker container.
22 Commits 1 Branch 0 Tags 69 KiB
Shell 100%
b1cd00abfa
Go to file
Tha_14 b1cd00abfa
doc: fix steps for the new way to include PBKEY
2023-01-05 21:59:10 +02:00
.github feat: add issue templates 2022-12-29 02:24:09 +02:00
uam feat: add wondershaper and update README.md 2022-12-29 15:23:46 +02:00
uam-swarm feat: add wondershaper and update README.md 2022-12-29 15:23:46 +02:00
README.md doc: fix steps for the new way to include PBKEY 2023-01-05 21:59:10 +02:00

README.md

Run UAM in a Docker container

run-docker-compose-workflow

How to use:

Single UAM instance

  1. Make sure you have docker and docker-compose installed on your host.
  2. Clone this repository.
  3. If you're on windows or macos, make sure you change the volume path /opt/uam_data to something that works on your OS.
  4. Execute the following command in terminal while being in the uam directory of this repository:

PBKEY={YOURKEYHERE} docker-compose up -d

UAM Swarm

  1. Make sure you have docker and docker-compose installed on your host.
  2. Clone this repository.
  3. If you're on windows or macos, make sure you change the volume path /opt/uam_data/uam_ to something that works on your OS.
  4. Optionally, add or remove services according to your needs. You can copy and paste the existing services and modify the names, paths, and ports for each of them.
  5. Execute the following command in terminal while being in the uam-swarm directory of this repository:

PBKEY={YOURKEYHERE} docker-compose up -d

Information

  1. This container will download the latest version of uam every time it is started and will install apt packages so keep that in mind.
  2. The http service for uam is enabled and listening on http://127.0.0.1:17099 for the single instance. For the UAM swarm you need to define the listening port for each instance.
  3. Make sure you port forward manually as upnp will most likely not work.
  4. You can adjust the maximum upload and download bandwidth of uam by changing the NETLIMUP and NETLIMDOWN env variables.

ToDo:

  • Add CI tests to make sure the scripts work.
  • Make PBKEY a required variable to avoid running uam without it.
  • Include wondershaper or sch_cake in apt install and environment configuration parameters for it.
  • See if it's possible to automatically increment port numbers for the swarm script.