From c094ea8813a447050df202bd41f118c66606b921 Mon Sep 17 00:00:00 2001 From: L3D Date: Sun, 18 Feb 2024 17:55:50 +0100 Subject: [PATCH] Update README.md Signed-off-by: L3D --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5a13122..3fe18df 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,40 @@ [![Ansible Galaxy](https://ansible.l3d.space/svg/l3d.rustdesk.svg)](https://galaxy.ansible.com/ui/standalone/roles/l3d/rustdesk/) -[![BSD-3 Clause](https://ansible.l3d.space/svg/l3d.rustdesk_license.svg)](LICENSE) +[![MIT](https://ansible.l3d.space/svg/l3d.rustdesk_license.svg)](LICENSE) [![Maintainance](https://ansible.l3d.space/svg/l3d.rustdesk_maintainance.svg)](https://ansible.l3d.space/#l3d.rustdesk) ansible_role_template ======================= +Ansible role to install a selfhosted rustdesk-server. DOCS: https://rustdesk.com/docs/en/self-host/ Core Ports: TCP 21115-21117 UDP 21116 -WORK IN PROGRESS! +## Variables: + +```yml +--- +rustdesk__version: 'latest' + +rustdesk__user: 'rustdesk' +rustdesk__group: "{{ rustdesk__user }}" +rustdesk__home: '/var/lib/rustdesk' +rustdesk__user_home: "{{ rustdesk__home }}" +rustdesk__ignore_version_mismatch: false +rustdesk__require_key: true +rustdesk__relay_server_domain: "{{ ansible_fqdn }}" +rustdesk__relay_server_port: '21117' +rustdesk__signal_server_port: '21116' + +rustdesk__hbbr_executable_path: '/usr/local/bin/hbbr' +rustdesk__hbbs_executable_path: '/usr/local/bin/hbbs' +rustdesk__rustdesk_utils_executable_path: '/usr/local/bin/rustdesk-utils' + +# should we do a version check? (recomended) +submodules_versioncheck: false +``` + +# TODOs ++ Create more fancy DOCs ++ Create logos on ansible.l3d.space