Skip to content

Latest commit

 

History

History
462 lines (340 loc) · 18.9 KB

README-NL.md

File metadata and controls

462 lines (340 loc) · 18.9 KB
Raw

Manually • Docker • Keypair • Binaries • Variables
[French] | [Deutsch] | [Nederlands] | [繁體中文] | [简体中文] | [Русский]

SctgDesk Server Programma

Docker Pulls build build build

Binaire download

API-documentatie

Dit is een aangepaste versie van RustDesk Server, die gratis en open source is.

  • Het eerste verschil is dat deze versie de nieuwe Tcp modus inbegrepen in de RustDesk Server Pro-versie.
  • Het tweede verschil is dat deze versie een voorlopige implementatie van de Rustdesk Server Pro API-server bevat.
    • Ondersteuning voor persoonlijk adresboek
    • Ondersteuning voor gedeeld adresboek op groepsniveau
      • alleen-lezen, lezen-schrijven, admin
    • Ondersteuning voor gedeeld adresboek op gebruikersniveau
      • alleen-lezen, lezen-schrijven, admin
  • Het derde verschil is dat deze versie een voorlopige implementatie van een eenvoudige webconsole bevat.

De webconsole is toegankelijk op het adres http://<server-ip>:21114/ met login "admin" en wachtwoord "Hallo, wereld!" .
U kunt de API-documentatie in de ingebouwde API-server doorzoeken op het adres http://<server-ip>:21114/api/doc/.

Een niet-interactieve API-documentatie is beschikbaar op sctgdesk-api-server opslagplaats.

Geef het project een ster

Als je mijn werk waardeert, overweeg dan om het een ster te geven! 🤩 of een

TL; DR

U kunt het volgende gebruiken docker-compose.yml bestand om de server te starten:

version: '3'

networks:
  sctgdesk-net:
    external: false

services:
  hbbs:
    container_name: hbbs
    ports:
      - 21114:21114
      - 21115:21115
      - 21116:21116
      - 21116:21116/udp
      - 21118:21118
    image: sctg/sctgdesk-server:latest
    command: hbbs -r sctgdesk.example.com:21117
    volumes:
      - ./data:/usr/local/share/sctgdesk
    networks:
      - sctgdesk-net
    depends_on:
      - hbbr
    restart: unless-stopped

  hbbr:
    container_name: hbbr
    ports:
      - 21117:21117
      - 21119:21119
    image: sctg/sctgdesk-server:latest
    command: hbbr
    volumes:
      - ./data:/usr/local/share/sctgdesk
    networks:
      - sctgdesk-net
    restart: unless-stopped

en start de server met:

mkdir -p data
docker-compose up

Binaries

Binaire bestanden zijn beschikbaar voor de volgende platforms:

  • Linux x86_64 statisch gekoppeld
  • Linux arm64 statisch gekoppeld
  • Linux armv7 statisch gekoppeld
  • MacOS Intel
  • MacOS Apple Silicium
  • Windows x86_64

Standaard admin-gebruiker

De standaard admin-gebruiker wordt gemaakt met de gebruikersnaam admin en het wachtwoord Hello,world!. U kunt het wachtwoord wijzigen na de eerste keer inloggen op de webconsole.

API Standalone versie

De api standalone versie is een versie van de server die de API-server en de webconsole bevat, maar niet de rendez-vous server.
De standalone versie is beschikbaar in een eigen repository sctgdesk-api-server.
Voor alle api- of webconsole-gerelateerde problemen verwijzen wij u naar de sctgdesk-api-server opslagplaats.

Schermafbeeldingen

Webconsole

login dashboard devices users groups address books rues add rules

Api-documentatie

apidoc

Gebruik in Rustdesk client

Capture d’écran 2024-05-24 à 12 14 34 Capture d’écran 2024-05-24 à 12 07 21 Capture d’écran 2024-05-24 à 12 07 32

Autoupdate-links genereren

We hebben onze client aangepast om de autoupdate-links van de api-server op te halen in plaats van uit Github-releases.
Om de autoupdate-links te laten werken, moet u uw client wijzigen om de autoupdate-links van de api-server op te halen. Dit Hoe je het kunt doen:

// src/common.rs
#[tokio::main(flavor = "current_thread")]
async fn check_software_update_() -> hbb_common::ResultType<()> {
    let url=format!("{}/api/software/releases/latest",get_api_server("".to_owned(), "".to_owned())).to_owned();
    log::info!("URL for checking software updates: {}", url);
    //let url = "https://github.com/rustdesk/rustdesk/releases/latest";
    let latest_release_response = create_http_client_async().get(url).send().await?;
    let latest_release_version = latest_release_response
        .url()
        .path()
        .rsplit('/')
        .next()
        .unwrap_or_default();

    let response_url = latest_release_response.url().to_string();

    if get_version_number(&latest_release_version) > get_version_number(crate::VERSION) {
        *SOFTWARE_UPDATE_URL.lock().unwrap() = response_url;
    }
    Ok(())
}

Veiligheid

De embedded API-server is niet beveiligd of beschermd tegen DDOS-aanvallen. Een goede gewoonte is om een reverse proxy voor de API-server te gebruiken. NGINX is hiervoor een goede keuze. HAProxy is ook een goede keuze.
Wij gebruiken HAProxy voor de API-server in onze productieomgeving. Dit is ons configuratiebestand voor HAProxy, het wordt alleen als voorbeeld gegeven. Je moet het aanpassen aan je eigen behoeften.:

global
    log /dev/log    local0
    log /dev/log    local1 notice
    chroot /var/lib/haproxy
    stats socket /run/haproxy/admin.sock mode 660 level admin expose-fd listeners
    stats timeout 30s
    user haproxy
    group haproxy
    daemon

defaults
    log global
    retries 2
    timeout connect 3000ms
    timeout server 5000ms
    timeout client 5000ms

frontend hbbs_wss
    bind 0.0.0.0:21120 ssl crt /etc/haproxy/hbb.pem
    default_backend hbbs_wss_backend

frontend hbbs_api
    mode http
    option forwardfor
    bind 0.0.0.0:21114 ssl crt /etc/haproxy/api.pem
    http-request set-header X-Forwarded-Proto https
    default_backend hbbs_api_backend

frontend hbbs_api_443
    mode http
    option forwardfor
    bind 0.0.0.0:443 ssl crt /etc/haproxy/api.pem
    http-request set-header X-Forwarded-Proto https
    filter compression
    compression algo gzip
    compression type text/css text/html text/javascript application/javascript text/plain text/xml application/json
    compression offload
    default_backend hbbs_api_backend

frontend hbbr_wss
    bind 0.0.0.0:21121 ssl crt /etc/haproxy/hbb.pem
    default_backend hbbr_wss_backend

backend hbbs_api_backend
    mode http
    server srv_main 127.0.0.1:21113

backend hbbs_wss_backend
    server srv_main 127.0.0.1:21118

backend hbbr_wss_backend
    server srv_main 127.0.0.1:21119

De hbbs-server wordt gestart met

[Unit]
Description=Rustdesk Signal Server

[Service]
Type=simple
LimitNOFILE=1000000
ExecStart=/usr/bin/hbbs --api-port=21113 -k AucFCOYVWNHRkJnx13FFh7C0tmUZ3nei5wXKmlfK6WPYthz65fRavaA5HO/OIz2kq+bCSlAqBkZgvikwVGqw/Q== --mask=10.10.0.235/24 -r rendez-vous.example.org -R rendez-vous.example.org
#Environment="RUST_LOG=debug"
Environment="ALWAYS_USE_RELAY=Y"
Environment="OAUTH2_CREATE_USER=1"
Environment="S3CONFIG_FILE=s3config.toml"
Environment="OAUTH2_CONFIG_FILE=oauth2.toml"
WorkingDirectory=/var/lib/rustdesk-server/
User=
Group=
Restart=always
StandardOutput=append:/var/log/rustdesk-server/hbbs.log
StandardError=append:/var/log/rustdesk-server/hbbs.error
# Restart service after 10 seconds if node service crashes
RestartSec=10

[Install]
WantedBy=multi-user.target

Beperk ongewenste toegang

Om de toegang tot uw server te beperken, kunt u de --logged-in-only optie of stel de knop in LOGGED_IN_ONLY=Y omgevingsvariabele voor de hbbs server. Dit beperkt de controle tot alleen ingelogde gebruikers.

Zelfs als deze optie is ingeschakeld, kunnen gebruikers zich nog steeds registreren op de Rendez-vous-server, maar kunnen ze de peer van een andere gebruiker niet beheren. Als iemand een peer probeert te beheren zonder ingelogd te zijn, krijgt hij of zij een foutmelding:

Error message for unauthenticated control attempt

Door deze functie in te schakelen, kunt u een extra beveiligingslaag aan uw server toevoegen en ongeoorloofde toegang voorkomen.

Configureren LOGGED_IN_ONLY

Om deze functie in te schakelen:

  1. Stel de knop in LOGGED_IN_ONLY=Y omgevingsvariabele voor de hbbs server.
  2. Als alternatief kunt u de --logged-in-only optie bij het uitvoeren van de hbbs server.

Voorbeeld

Om de LOGGED_IN_ONLY omgevingsvariabele, kunt u de volgende regel toevoegen aan uw ~/.bashrc bestand of gelijkwaardig:

export LOGGED_IN_ONLY=Y

RustDesk Server Programma

build build build

Downloaden

Handmatig

FAQ

Zelf uw eigen RustDesk-server hosten, deze is gratis en open source.

Handmatig bouwen

Eerst moet je een werkende Rust-ontwikkelingstoolchain en een Node ≥ 20 werkende installatie hebben.

  • Unices (Linux, MacOS, enz.):
DATABASE_URL=sqlite://$(pwd)/db_v2.sqlite3 cargo build --release
  • Vensters met cmd.exe shell:
set "DATABASE_URL=sqlite://%CD%/db_v2.sqlite3" && cargo build --release

Er worden drie uitvoerbare bestanden gegenereerd in target/release.

  • hbbs - RustDesk ID/Rendezvous server met API server
  • hbbr - RustDesk relay server
  • rustdesk-utils - RustDesk CLI hulpprogramma's

U kunt bijgewerkte binaire bestanden vinden op de Releases bladzijde.

Alle vrijgegeven binaire bestanden na release v1.1.99-40 worden geattesteerd met Github-acties. U kunt de attestatie controleren door de sha256som van het binaire bestand te controleren met https://search.sigstore.dev/?hash=<sha256> bijvoorbeeld.

Als je extra functies wilt RustDesk Server Pro zou misschien beter bij je passen.

Als u uw eigen server wilt ontwikkelen, rustdesk-server-demo is misschien een betere en eenvoudigere start voor u dan deze repo.

Docker-afbeeldingen

Docker-afbeeldingen worden automatisch gegenereerd en gepubliceerd op elke github-release.

Deze beelden zijn gebouwd tegen ubuntu-22.04 met de enige toevoeging van de belangrijkste binaire bestanden (hbbr en hbbs). Ze zijn beschikbaar op Docker-hub met deze tags:

Architectuur Afbeelding:Tag
AMD64 sctg/sctgdesk-server:latest
arm64v8 sctg/sctgdesk-server:latest
arm32v7 sctg/sctgdesk-server:latest

U kunt deze afbeeldingen direct starten met docker run met deze commando's:

docker run --name hbbs --net=host -v "$PWD/data:/usr/local/share/sctgdesk" -d sctg/sctgdesk-server:latest hbbs -r <relay-server-ip[:port]> 
docker run --name hbbr --net=host -v "$PWD/data:/usr/local/share/sctgdesk" -d sctg/sctgdesk-server:latest hbbr

of zonder --net=host, maar directe P2P-verbinding kan niet werken.

Voor systemen die SELinux gebruiken, moet de /root bij /root:z is nodig om de containers correct te laten werken. Als alternatief kan SELinux-containerscheiding volledig worden uitgeschakeld, waardoor de optie wordt toegevoegd --security-opt label=disable.

docker run --name hbbs -p 21114:21114 -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v "$PWD/data:/usr/local/share/sctgdesk" -d sctg/sctgdesk-server:latest hbbs -r <relay-server-ip[:port]> 
docker run --name hbbr -p 21117:21117 -p 21119:21119 -v "$PWD/data:/usr/local/share/sctgdesk" -d sctg/sctgdesk-serverlatest hbbr

De relay-server-ip parameter is het IP-adres (of DNS-naam) van de server waarop deze containers worden uitgevoerd. De facultatief port parameter moet worden gebruikt als u een andere poort gebruikt dan 21117 voor hbbr.

U kunt ook docker-compose gebruiken, waarbij u deze configuratie als sjabloon gebruikt:

version: '3'

networks:
  sctgdesk-net:
    external: false

services:
  hbbs:
    container_name: hbbs
    ports:
      - 21114:21114
      - 21115:21115
      - 21115:21115
      - 21116:21116
      - 21116:21116/udp
      - 21118:21118
    image: sctg/sctgdesk-server:latest
    command: hbbs -r sctgdesk.example.com:21117
    volumes:
      - ./data:/usr/local/share/sctgdesk
    networks:
      - sctgdesk-net
    depends_on:
      - hbbr
    restart: unless-stopped

  hbbr:
    container_name: hbbr
    ports:
      - 21117:21117
      - 21119:21119
    image: sctg/sctgdesk-server-server:latest
    command: hbbr
    volumes:
      - ./data:/usr/local/share/sctgdesk
    networks:
      - sctgdesk-net
    restart: unless-stopped

Bewerk regel 16 om naar uw relay-server te verwijzen (degene die luistert op poort 21117). U kunt ook de volumelijnen (lijn 18 en lijn 33) bewerken als dat nodig is.

(Docker-Compose Credits gaat naar @lukebarone en @QuiGonLeong)

Merk op dat hier de sctg/sctgdesk-server-server:latest in China kan worden vervangen door het nieuwste versienummer op dockerhub, zoals sctg/sctgdesk-server-server:1.1.99-37. Anders kan de oude versie worden teruggetrokken vanwege beeldversnelling.

Hoe maak je een sleutelpaar aan?

Voor versleuteling is een sleutelpaar nodig; Je kunt het verstrekken, zoals eerder uitgelegd, maar je hebt een manier nodig om er een te maken.

U kunt deze opdracht gebruiken om een sleutelpaar te genereren:

/usr/bin/rustdesk-utils genkeypair

Als je de rustdesk-utils pakket dat op uw systeem is geïnstalleerd, kunt u dezelfde opdracht aanroepen met Docker:

docker run --rm --entrypoint /usr/bin/rustdesk-utils  sctg/sctgdesk-server-server:latest genkeypair

De uitvoer ziet er ongeveer zo uit:

Public Key:  8BLLhtzUBU/XKAH4mep3p+IX4DSApe7qbAwNH9nv4yA=
Secret Key:  egAVd44u33ZEUIDTtksGcHeVeAwywarEdHmf99KM5ajwEsuG3NQFT9coAfiZ6nen4hfgNICl7upsDA0f2e/jIA==

Pakketten

Voor elk binair bestand zijn aparte .deb pakketten beschikbaar, deze vind je in de Releases. Deze pakketten zijn bedoeld voor de volgende distributies:

  • Ubuntu 22.04 LTS
  • MacOS Intel of Apple Silicium
  • Windows x86_64 en i686

ENV-variabelen

hbbs en hbbr kunnen worden geconfigureerd met behulp van deze ENV-variabelen. U kunt de variabelen zoals gewoonlijk specificeren of een .env bestand.

variabel binair Beschrijving
ALWAYS_USE_RELAY hbbs indien ingesteld op "Y" Directe peer-verbinding is niet toegestaan
DOWNGRADE_START_CHECK HBBR Vertraging (in seconden) voor downgradecontrole
DOWNGRADE_THRESHOLD HBBR Drempel voor downgradecontrole (bit/ms)
SLEUTEL HBBS/HBBR indien ingesteld dwingt u het gebruik van een specifieke toets af, indien ingesteld op "_" Forceer het gebruik van een sleutel
LIMIT_SPEED HBBR snelheidslimiet (in Mb/s)
OAUTH2_CONFIG_FILE hbbs Pad voor OAUTH2 configuratiebestand
OAUTH2_CREATE_USER hbbs indien ingesteld op "1" Een gebruiker maken als deze niet bestaat
HAVEN HBBS/HBBR Luisterpoort (21116 voor HBBS - 21117 voor HBBR)
RELAIS hbbs IP-adres/DNS-naam van de machines waarop hbbr draait (gescheiden door komma's)
RUST_LOG allemaal Foutopsporingsniveau instellen (fout
S3CONFIG_FILE hbbs Pad voor S3 configuratiebestand
SINGLE_BANDWIDTH HBBR maximale bandbreedte voor een enkele verbinding (in Mb/s)
TOTAL_BANDWIDTH HBBR maximale totale bandbreedte (in Mb/s)