Merge pull request #48 from d3vilh/rust

Rustdesktop Server

Author: d3vilh

README.md

@@ -10,6 +10,7 @@
   * [**GlueTun**](https://github.com/qdm12/gluetun) - universal OpenVPN and Wireguard client for multiple VPN providers, using DNS over TLS and a few proxy servers built-in.
   * [**WireGuard Server**](https://github.com/d3vilh/raspberry-gateway/tree/master/wireguard) with own WEB UI for easy management. 
   * [**Xray Server**](https://github.com/d3vilh/raspberry-gateway/blob/master/xray/README.md) with experimental Shadowsocks and XTLS-Reality fast tunnel proxy that helps you to bypass firewalls. 
+  * [**Rustdesk OSS Server**](https://rustdesk.com) is a remote desktop software that allows you to connect to a remote computer from anywhere in the world. It is an alternative to TeamViewer, AnyDesk, and Chrome Remote Desktop.
   * [**qBittorrent**](https://www.qbittorrent.org) -  an open-source software alternative to µTorrent. 
   * [**Grafana Dashboards**](https://github.com/d3vilh/raspberry-gateway/tree/master/monitoring) for Internet speed, VPN, Raspberry Pi hardware and Docker containers monitoring. 
   * **Various Prometheus exporters**: cAdviser, AirGradient, StarLink, ShellyPlug and others. 
@@ -236,6 +237,8 @@ Overall, this Raspberry Pi Home Internet Gateway provides a universal solution f
 
 ![Portainer](/images/portainer.png)
 
+[**Rustdesk OSS Server**](https://rustdesk.com) is a remote desktop software that allows you to connect to a remote computer from anywhere in the world. It is an alternative to TeamViewer, AnyDesk, and Chrome Remote Desktop.
+
 [**Raspi Monitoring**](https://github.com/d3vilh/raspberry-gateway/tree/master/monitoring) The simple yet powerfull monitoring solution for your Raspberry Gateway. Covers performance utilisation (CPU,MEM,I/O, storage usage), Hardware utilisation (Temperature, Voltage, Power States, Devices Clock), Docker containers statistics and Internet connection monitoring:
 
 ![Raspberry Monitoring Dashboard in Grafana picture 1](/images/raspi-monitoring_1.png) 
@@ -356,6 +359,19 @@ Overall, this Raspberry Pi Home Internet Gateway provides a universal solution f
      * default pannel port in `Pannel Settings` > `Pannel Configurations` > `Pannel Port` from `54321` to some random port (the best in the upper end of the range, up to `65535`)
      * default configuration pannel URL in `Pannel Settings` > `Pannel Configurations` > `Panel URL Root Path` to something random, like `/mysecretpannel/` or `/superxray/`.
 
+  ## Rustdesk Server
+   #### Rustdesk facts:
+   * **UI access port** No UI available in [OSS version](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/), running in Back-End.
+   * **Default password** Use public key from configuration files.
+   * **External ports** used by container in host mode: `21115:tcp` (Relay) `21116:tcp/udp` (ID Registration), `21117:tcp` (WebRTC Hole punching).
+   * **Configuration files** are available after the installation and located in `~/rustdesk-server/*` directory
+   Publik Key is located in `~/rustdesk-server/data/id_ed*.pub` file. 
+   You need it to [configure](https://rustdesk.com/docs/en/client/) your [Rustdesk clients](https://rustdesk.com/download) sides:
+     ```shell
+     pi@d3vpi:~ $ cat ~/rustdesk-server/data/id_ed*.pub
+     bvij9KsmajenaOdt9AazKURKAtnz1FLBGt8+5goUK4WZs=
+     ```
+
   ## Raspberry-monitoring
   All the Data sources, Dashboards and exporters are automatically provisioned. Below you can find the list of available dashboards and their URLs.
 

example.config.yml

@@ -177,6 +177,18 @@ qbittorrent_inside_vpn: false                    # Set true to route qBitTorrent
 qbittorrent_inside_gluetun: false                # Set true to route qBitTorrent traffic via Gluetun VPN client
 qbittorrent_webui_port: 8090                     # Do not change it unless you know what you are doing.
 
+                                     
+#    _____         _   ____          _   
+#   | __  |_ _ ___| |_|    \ ___ ___| |_ 
+#   |    -| | |_ -|  _|  |  | -_|_ -| '_|
+#   |__|__|___|___|_| |____/|___|___|_,_|
+# Rustdesk-server configuration.                                 
+rustdesk_enable: false                          # Set true to enable Rustdesk-server
+remove_rustdesk: false                          # Set true to remove Rustdesk-server
+# Experimental feature. Not tested yet.
+# https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/docker/
+
+
 #    _____         _ _               
 #   |     |___ ___|_| |_ ___ ___ ___ 
 #   | | | | . |   | |  _| . |  _|_ -|

images/OpenVPN-UI-Home.1.png

@@ -89,6 +89,11 @@
       ansible.builtin.import_tasks: tasks/xray-xui.yml
       when: xray_enable 
 
+    - name: Setup Rustdesk
+      become: true
+      ansible.builtin.import_tasks: tasks/rustdesk-server.yml
+      when: rustdesk_enable 
+
     - name: Setup Raspberry Monitoring
       become: true
       ansible.builtin.import_tasks: tasks/raspberry-monitoring.yml
@@ -120,4 +125,5 @@
           - remove_airgradient_monitoring
           - remove_starlink_monitoring
           - remove_shelly_plug_monitoring
+          - remove_rustdesk
       when: remove_conditions | select('match', '^remove_') | list | length > 0

main.yml

@@ -95,4 +95,11 @@
     project_src: "{{ config_dir }}/xray/"
     build: never
     state: restarted
+  become: false
+
+- name: Restart rustdesk
+  community.docker.docker_compose_v2:
+    project_src: "{{ config_dir }}/rustdesk-server/"
+    build: never
+    state: restarted
   become: false

tasks/handlers.yml

@@ -310,7 +310,6 @@
       become: true
       when: remove_xray
 
-
 - name: Remove Samba
   block:
     - name: Stop and remove Samba Server container
@@ -327,6 +326,23 @@
       become: true
       when: remove_samba
 
+- name: Remove Rustdesk
+  block:
+    - name: Stop and remove Rustdesk server container
+      community.docker.docker_compose_v2:
+        project_src: "{{ config_dir }}/rustdesk-server/"
+        state: absent
+      become: false
+      ignore_errors: yes
+      when: remove_rustdesk
+
+    - name: Remove Rustdesk server image
+      community.docker.docker_image:
+        name: rustdesk/rustdesk-server
+        state: absent
+      become: true
+      when: remove_rustdesk
+
   #  - name: Remove Samba Server network
   #    community.docker.docker_network:
   #      name: samba-server-net

tasks/remove.yml

@@ -0,0 +1,32 @@
+---
+- name: Create Rustdesk folder on Pi.
+  ansible.builtin.file:
+    path: "{{ config_dir }}/rustdesk-server"
+    state: directory
+    mode: 0755
+  become: false
+
+# WA for 60sec TMO bug
+- name: Pulling latest Rustdesk server image
+  community.general.docker_image:
+    source: pull
+    name: rustdesk/rustdesk-server
+    tag: latest
+  become: false
+
+- name: Copy Rustdesk docker-compose template to Pi.
+  ansible.builtin.template:
+    src: templates/rustdesk-docker-compose.yml.j2
+    dest: "{{ config_dir }}/rustdesk-server/docker-compose.yml"
+    mode: '0640'
+  become: false
+  notify: Restart rustdesk
+
+- name: Ensure Rustdesk server is running.
+  community.docker.docker_compose_v2:
+    project_src: "{{ config_dir }}/rustdesk-server/"
+    build: never
+  become: false
+  environment:
+    DOCKER_CLIENT_TIMEOUT: '180'
+    COMPOSE_HTTP_TIMEOUT: '180'  

tasks/rustdesk-server.yml

@@ -0,0 +1,23 @@
+services:
+  hbbs:
+    container_name: hbbs
+    image: rustdesk/rustdesk-server:latest
+    environment:
+      - ALWAYS_USE_RELAY=Y
+    command: hbbs
+    volumes:
+      - ./data:/root
+    network_mode: "host"
+
+    depends_on:
+      - hbbr
+    restart: unless-stopped
+
+  hbbr:
+    container_name: hbbr
+    image: rustdesk/rustdesk-server:latest
+    command: hbbr
+    volumes:
+      - ./data:/root
+    network_mode: "host"
+    restart: unless-stopped