docs: update README.md to reflect new changes

README.md

@@ -1,5 +1,6 @@
 # Run UAM in a Docker container
-[![run-docker-compose-workflow](https://github.com/Tha14/uam-docker/actions/workflows/push.yml/badge.svg)](https://github.com/Tha14/uam-docker/actions/workflows/push.yml)
+[![Donate CRP](https://img.shields.io/badge/Donate-CRP-blue.svg)](https://cutt.ly/C2MoaCU) [![run-docker-compose-workflow](https://github.com/Tha14/uam-docker/actions/workflows/push.yml/badge.svg)](https://github.com/Tha14/uam-docker/actions/workflows/push.yml)
+##### If you find this project helpful you are welcome to make a donation.
 
 ## How to use:
 ### Single UAM instance
@@ -25,3 +26,5 @@
 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](https://github.com/jesseduffield/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`.
+

uam-swarm/docker-compose.yml

@@ -12,16 +12,19 @@ services:
       memlock: -1
     oom_score_adj: -700
     mem_swappiness: 10
+    cap_add:
+      - NET_ADMIN
     volumes:
       - "./entrypoint.sh:/opt/entrypoint.sh"
       - "/opt/uam_data/uam_1:/root/.uam"
-    command: /bin/sh -c "chmod +x /opt/entrypoint.sh && /opt/entrypoint.sh $${PBKEY} $${PPORT} $${NETLIMUP} $${NETLIMDOWN}"
+    command: /bin/sh -c "chmod +x /opt/entrypoint.sh && /opt/entrypoint.sh $${PBKEY} $${PPORT} $${NETLIMUP} $${NETLIMDOWN} $${ENABLE_WONDERSHAPER}"
     ports:
       - "127.0.0.1:17100:17099"
       - "4160:4160"
     environment:
       - PBKEY=${PBKEY?err}
       - PPORT=4160
+      - ENABLE_WONDERSHAPER=true
       - NETLIMUP=10000
       - NETLIMDOWN=18000
 
@@ -36,16 +39,19 @@ services:
       memlock: -1
     oom_score_adj: -700
     mem_swappiness: 10
+    cap_add:
+      - NET_ADMIN
     volumes:
       - "./entrypoint.sh:/opt/entrypoint.sh"
       - "/opt/uam_data/uam_2:/root/.uam"
-    command: /bin/sh -c "chmod +x /opt/entrypoint.sh && /opt/entrypoint.sh $${PBKEY} $${PPORT} $${NETLIMUP} $${NETLIMDOWN}"
+    command: /bin/sh -c "chmod +x /opt/entrypoint.sh && /opt/entrypoint.sh $${PBKEY} $${PPORT} $${NETLIMUP} $${NETLIMDOWN} $${ENABLE_WONDERSHAPER}"
     ports:
       - "127.0.0.1:17101:17099"
       - "4161:4161"
     environment:
       - PBKEY=${PBKEY?err}
       - PPORT=4161
+      - ENABLE_WONDERSHAPER=true
       - NETLIMUP=10000
       - NETLIMDOWN=18000
 
@@ -60,15 +66,18 @@ services:
       memlock: -1
     oom_score_adj: -700
     mem_swappiness: 10
+    cap_add:
+      - NET_ADMIN
     volumes:
       - "./entrypoint.sh:/opt/entrypoint.sh"
       - "/opt/uam_data/uam_3:/root/.uam"
-    command: /bin/sh -c "chmod +x /opt/entrypoint.sh && /opt/entrypoint.sh $${PBKEY} $${PPORT} $${NETLIMUP} $${NETLIMDOWN}"
+    command: /bin/sh -c "chmod +x /opt/entrypoint.sh && /opt/entrypoint.sh $${PBKEY} $${PPORT} $${NETLIMUP} $${NETLIMDOWN} $${ENABLE_WONDERSHAPER}"
     ports:
       - "127.0.0.1:17102:17099"
       - "4162:4162"
     environment:
       - PBKEY=${PBKEY?err}
       - PPORT=4162
+      - ENABLE_WONDERSHAPER=true
       - NETLIMUP=10000
       - NETLIMDOWN=18000

uam-swarm/entrypoint.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 cd /tmp
 apt update && apt -yq install wget libglib2.0-0 ca-certificates dnsmasq wondershaper
 update-ca-certificates
@@ -8,5 +8,7 @@ cd /opt/uam/
 echo "[net]" >> /root/.uam/uam.ini
 container_ip="$(hostname -i)"
 echo "listens=[${container_ip}]:$2" >> /root/.uam/uam.ini
-wondershaper eth0 $3 $4 &
+if [[ "$5" == "true" ]]; then
+  wondershaper eth0 $3 $4 &
+fi
 ./uam --pk $1 --http [0.0.0.0]:17099 --no-ui

uam/docker-compose.yml

@@ -17,11 +17,12 @@ services:
     volumes:
       - "./entrypoint.sh:/opt/entrypoint.sh"
       - "/opt/uam_data:/root/.uam"
-    command: /bin/sh -c "chmod +x /opt/entrypoint.sh && /opt/entrypoint.sh $${PBKEY} $${NETLIMUP} $${NETLIMDOWN}"
+    command: /bin/sh -c "chmod +x /opt/entrypoint.sh && /opt/entrypoint.sh $${PBKEY} $${NETLIMUP} $${NETLIMDOWN} $${ENABLE_WONDERSHAPER}"
     ports:
       - "127.0.0.1:17099:17099"
       - "4156:4156"
     environment:
       - PBKEY=${PBKEY?err}
+      - ENABLE_WONDERSHAPER=true
       - NETLIMUP=10000
       - NETLIMDOWN=18000

uam/entrypoint.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 cd /tmp
 apt update && apt -yq install wget libglib2.0-0 ca-certificates dnsmasq wondershaper
 update-ca-certificates
@@ -8,5 +8,7 @@ cd /opt/uam/
 echo "[net]" >> /root/.uam/uam.ini
 container_ip="$(hostname -i)"
 echo "listens=[${container_ip}]:4156" >> /root/.uam/uam.ini
-wondershaper eth0 $2 $3 &
+if [[ "$4" == "true" ]]; then
+  wondershaper eth0 $2 $3 &
+fi
 ./uam --pk $1 --http [0.0.0.0]:17099 --no-ui