Tha_14/uam-docker
1
0
Fork 0
mirror of https://github.com/Tha14/uam-docker.git synced 2024-11-24 21:43:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: add suggestion regarding container control

Browse Source
This commit is contained in:
Tha_14 2023-01-06 17:22:47 +02:00 committed by GitHub
parent 2ecfbee04d
commit d6ae0cd436
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -14,16 +14,17 @@
1. Make sure you have docker and docker-compose installed on your host. 1. Make sure you have docker and docker-compose installed on your host.
2. Clone this repository. 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. 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.
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. 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: 5. Execute the following command in terminal while being in the `uam-swarm` directory of this repository:
```PBKEY={YOURKEYHERE} docker-compose up -d``` ```PBKEY={YOURKEYHERE} docker-compose up -d```
## Information ## 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. 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. 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. 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. 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](https://github.com/jesseduffield/lazydocker) to control and see the status of your containers.
## ToDo: ## ToDo:
- [x] Add CI tests to make sure the scripts work. - [x] Add CI tests to make sure the scripts work.