Merge pull request #4 from Poeschl/refactoring-the-sync

♻️ Complete refactoring of the container.

Author: Poeschl

Dockerfile

@@ -1,5 +1,5 @@
 FROM docker.io/debian:bookworm-slim as resources
-ENV DEBIAN_FRONTEND=noninteractive
+ENV DEBIAN_FRONTEND=noninteractive TERM=xterm-256color
 
 RUN apt-get update && apt-get install --no-install-recommends -y \
     wget tar ca-certificates sed
@@ -8,40 +8,29 @@ RUN wget https://www.eti-lan.xyz/sync_server.tar \
     && mkdir /sync_server \
     && tar xvf sync_server.tar -C /sync_server
 
-# Patch a permission change for /lan
-RUN sed -i '/start() {/a chmod -R 0777 /lan; ls -al /lan' /sync_server/etc/init.d/eti
+# Fix sync folder path
+RUN sed -i 's|/lan/|/$sync_dir/|' /sync_server/etc/init.d/eti
 
+# Patch resilio sync out of the init script
+RUN sed -i '/resilio-sync/s/^/#/' /sync_server/etc/init.d/eti
+
+# Patch iptables sync out of the init script
+# Firewalling should be handled by the host
+RUN sed -i '/iptables/s/^/#/' /sync_server/etc/init.d/eti \
+  && sed -i '/ip6tables/s/^/#/' /sync_server/etc/init.d/eti
+
+# Set the terminal width to a fixed value to avoid issues with the init script
+RUN sed -i 's/terminal_width=$(tput cols)/terminal_width=100/' /sync_server/etc/init.d/eti \
+ && sed -i '/clear/s/^/#/' /sync_server/etc/init.d/eti
 
 FROM docker.io/debian:bookworm-slim as running
-ENV DEBIAN_FRONTEND=noninteractive
+ENV DEBIAN_FRONTEND=noninteractive TERM=xterm-256color
 
-RUN apt-get update && apt-get install --no-install-recommends -y wget gnupg ca-certificates systemd systemd-sysv iproute2 procps \
+RUN apt-get update && apt-get install --no-install-recommends -y curl sqlite3 \
     && apt-get clean \
     && rm -rf /var/lib/apt/lists/*
 
-RUN echo "deb http://linux-packages.resilio.com/resilio-sync/deb resilio-sync non-free" > /etc/apt/sources.list.d/resilio-sync.list \
-    && wget -qO - http://linux-packages.resilio.com/resilio-sync/key.asc | apt-key add - \
-    && wget -O resilio-sync.deb https://download-cdn.resilio.com/2.7.3.1381/Debian/resilio-sync_2.7.3.1381-1_amd64.deb \
-    && apt-get update \
-    && apt-get install --no-install-recommends -y net-tools curl sqlite3 iptables iptables-persistent \
-    && dpkg -i resilio-sync.deb \
-    && apt-mark hold resilio-sync \
-    && apt-get clean \
-    && rm -rf /var/lib/apt/lists/* \
-    && rm -f resilio-sync.deb
-
 COPY --from=resources /sync_server /
 
-RUN echo "alias eti='/etc/init.d/eti'" >> /root/.bashrc \
-    && update-rc.d eti defaults \
-    && update-rc.d -f resilio-sync remove \
-    && chmod +x /etc/rc.local \
-    && echo 'root:lan' | chpasswd
-
-RUN mkdir /lan && chmod 0777 /lan
-VOLUME /lan
-VOLUME /etc/iptables
-
-STOPSIGNAL SIGRTMIN+3
-EXPOSE 8888
-ENTRYPOINT ["/usr/sbin/init"]
+ENTRYPOINT ["/etc/init.d/eti"]
+CMD ["start"]

README.md

@@ -3,25 +3,32 @@
 This is a dockerized version of the [Sync Server of the eti Lan Tools](https://www.eti-lan.xyz/sync_server.php).
 It will start the sync server inside a docker container and provides them locally to any installed eti [Lan-Launcher](https://www.eti-lan.xyz/).
 
+## Differences to the original server running in a VM
+
+* The container does not have any firewall functionality, so setting it to lan-only mode needs to be done by the host.
+* The commands of the VM-based sync server are not available. 
+  The server starts automatically in the container and shuts it down when the container stops, that's it.
+* There is no auto-update of the sync-server container itself, you need to pull the latest image manually.
+  However, the auto-update of the lan-launcher and its games works as usual.
+  So the sync server will always be up-to-date with the latest games of the eti Lan Tools after a successful start.
+
 ## Setup
 
 As a requirement for a successful operation make sure to have a __linux__ system and a __docker__ or a __rootful podman__ installation running.
-Since systemd is running inside the container we need those privileges (PRs to change welcome).
 
-To make the setup as easy as possible a docker-compose.yaml is provided.
+To make the setup as easy as possible a docker-compose.yaml and working config-files are provided in the `deploy` folder.
 Download it to a new folder and execute `podman-compose up -d` to run it in daemon mode in the background.
-The UI should be available under http://localhost:8888 and your hosts ip in the local network.
+The Resilio UI should be available under http://localhost:8888 and your hosts ip in the local network.
 (For the login look in the next section)
 
 ## Auth
 
-When logging into the container the authentication is:
+The default login for the Resilio Sync Web UI is:
 
+```
 User: `root`
-
 Password: `lan`
-
-This is the same as the default web-ui password. This can be changed via the custom config file `eti-config.conf`.
+```
 
 ## FAQ
 

deploy/docker-compose.yaml

@@ -0,0 +1,33 @@
+services:
+  eti-sync-server:
+    image: ghcr.io/poeschl/eti-sync-server
+    depends_on:
+      - resilio
+    volumes:
+      - ./eti-config.conf:/root/eti-config.conf
+
+      # Keep this line in sync with the data directory in the resilio container
+      - resilio-data:/sync:z
+      #- ./resilio-data:/sync:z
+
+  resilio:
+    image: linuxserver/resilio-sync:2.8.1
+    # use the host_network or the ports. It's up to you.
+    #network_mode: host
+    ports:
+      - 8888:8888
+      - 55555:55555
+    environment:
+      PUID: 1000
+      PGID: 1000
+      TZ: Europe/Berlin
+    volumes:
+      - ./resilio-config.conf:/config/sync.conf
+
+      # Keep this line to let docker take care of the data directory
+      - resilio-data:/sync:z
+      # Otherwise use the next line to keep the data directory in the current directory
+      #- ./resilio-data:/sync:z
+
+volumes:
+  resilio-data:

deploy/eti-config.conf

@@ -0,0 +1,16 @@
+# Sync Webinterface Login
+user=root
+pass=lan
+
+sync_dir=/sync
+
+
+# You should not change this
+syncoptions='&force=1&use_tracker=1&search_lan=1&use_dht=1&use_hosts=1&use_relay_server=1&overwrite_changes=1&folder_deletetotrash=0&use_sync_trash=0'
+eti_call='http://resilio:8888/api?method=add_folder&secret=BICDWADB4KCVNR6FCAGYTHEKZBYVUGTZX'
+eti_server_call='http://resilio:8888/api?method=add_folder&secret=BOS2KKF2RFQRQGKCC5U2YQNIWLPAQKHWY'
+eti_server_key='BOS2KKF2RFQRQGKCC5U2YQNIWLPAQKHWY'
+sync_call='http://resilio:8888/api?method=add_folder'
+remove_call='http://resilio:8888/api?method=remove_folder'
+prefs_call='http://resilio:8888/api?method=set_folder_prefs'
+exit_call='http://resilio:8888/api?method=shutdown'

deploy/resilio-config.conf

@@ -0,0 +1,28 @@
+{
+  "storage_path" : "/sync",
+  "device_name": "eti-sync-server",
+  "agree_to_EULA" : "yes",
+  "check_for_updates" : false,
+  "use_gui": false,
+  "use_upnp" : true,
+  "download_limit" : 0,
+  "upload_limit" : 0,
+  "rate_limit_local_peers": false,
+  "lan_encrypt_data": false,
+  "sync_max_time_diff": 172800,
+  "peer_expiration_days": 1,
+  "folder_defaults.lan_discovery_mode": 3,
+  // "folder_defaults.use_lan_broadcast": true,
+  // "service_folders.use_tracker": true,
+  "service_folders.use_relay": true,
+  "sync_trash_ttl": 1,
+  "send_statistics": false,
+
+  "webui" :
+  {
+    "listen" : "0.0.0.0:8888",
+    "login" : "root",
+    "password" : "lan",
+    "api_key" : "VGWWKFEB2BVHKUNMUPMZHTZFNEVSPWT5CO3UKNKOMXL54FOYDF7VQ2FTUK2M7HXQRMRZ4H5XPABI3NKR7EMCMCVEJDGG54RDO56AGASC2WTU366TPMDTTH4HUS4XWL5PHLK2LIA"
+  }
+}