mirror of
https://github.com/Tha14/uam-docker.git
synced 2024-11-24 19:53:02 +01:00
2.2 KiB
2.2 KiB
Run UAM in a Docker container
How to use:
Single UAM instance
- Make sure you have docker and docker-compose installed on your host.
- Clone this repository.
- 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. - Execute the following command in terminal while being in the
uam
directory of this repository:
PBKEY={YOURKEYHERE} docker-compose up -d
UAM Swarm
- Make sure you have docker and docker-compose installed on your host.
- Clone this repository.
- 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. - 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.
- Execute the following command in terminal while being in the
uam-swarm
directory of this repository:
PBKEY={YOURKEYHERE} docker-compose up -d
Important information:
- This container will download the latest version of uam every time it is started and will install apt packages so keep that in mind.
- 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.
- Make sure you port forward manually as upnp will most likely not work.
- You can adjust the maximum upload and download bandwidth of uam by changing the
NETLIMUP
andNETLIMDOWN
env variables. - I suggest using lazydocker to control and see the status of your containers.
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.