Tha_14/uam-docker
1
0
Fork 0
mirror of https://github.com/Tha14/uam-docker.git synced 2024-11-24 17:03:01 +01:00
Code Issues Packages Projects Releases Wiki Activity
A docker compose script for running UAM in a docker container.
29 Commits 1 Branch 0 Tags 69 KiB
Shell 100%
master
Go to file
Tha_14 c9d8dbc1c8
docs: add requirements per thread section, add examples for mounts on different OS
2023-01-24 01:05:21 +02:00
.github feat: add issue templates 2022-12-29 02:24:09 +02:00
uam fix: swarm net privileges, make wondershaper toggleable 2023-01-15 22:17:15 +02:00
uam-swarm fix: swarm net privileges, make wondershaper toggleable 2023-01-15 22:17:15 +02:00
README.md docs: add requirements per thread section, add examples for mounts on different OS 2023-01-24 01:05:21 +02:00

README.md

Run UAM in a Docker container

Donate CRP run-docker-compose-workflow

If you find this project helpful you are welcome to make a donation.

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, in the docker-compose.yml file, make sure you change the volume path /opt/uam_data to something that works on your OS. For example: on Windows something like c/uam_data, on macOS ${HOME}/uam_data.
  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, in the docker-compose.yml file, make sure you change the volume path /opt/uam_data/uam_ to something that works on your OS. For example: on Windows something like c/uam_data/uam_, on macOS ${HOME}/uam_data/uam_.
  4. Optionally, add or remove services according to your needs. You can copy and paste the existing services and incement 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

Important 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.
  5. I suggest using lazydocker to control and see the status of your containers.
  6. You can disable wondershaper(traffic shaping) if you're experiencing problems by setting ENABLE_WONDERSHAPER to false.

Requirements per thread:

  • 4300MB free ram RAM
  • 4 CPU cores
  • 10Mbps upload and download bandwidth
  • 100MB disk space
  • 32CRP held in your wallet or delegated to you