Merge pull request #43 from paspo/gh_actions

added build workflow
2024-11-27 14:59:21 +08:00 · 2022-06-29 01:02:44 +08:00 · 2022-06-29 01:02:44 +08:00 · 6c6dba5a8a
commit 6c6dba5a8a
parent c87e7bc848 104fb00d88
6 changed files with 449 additions and 19 deletions
--- a/.github/workflows/build.yaml
+++ b/.github/workflows/build.yaml
@ -0,0 +1,294 @@
+name: build
+
+# ------------- NOTE
+# please setup some secrets before running this workflow:
+# DOCKER_IMAGE should be the target image name on docker hub (e.g. "rustdesk/rustdesk-server-s6" )
+# DOCKER_IMAGE_CLASSIC should be the target image name on docker hub for the old build (e.g. "rustdesk/rustdesk-server" )
+# DOCKER_USERNAME is the username you normally use to login at https://hub.docker.com/
+# DOCKER_PASSWORD is a token you should create under "account settings / security" with read/write access
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+      - '[0-9]+.[0-9]+.[0-9]+'
+
+env:
+  CARGO_TERM_COLOR: always
+  LATEST_TAG: latest
+  
+jobs:
+
+  # binary build
+  build:
+
+    name: Build - ${{ matrix.job.name }}
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        job:
+          - { name: "amd64",   target: "x86_64-unknown-linux-musl" }
+          - { name: "arm64v8", target: "aarch64-unknown-linux-musl" }
+          - { name: "armv7",   target: "armv7-unknown-linux-musleabihf" }
+          - { name: "i386",    target: "i686-unknown-linux-musl" }
+
+    steps:
+      
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          override: true
+          default: true
+          target: ${{ matrix.job.target }}
+
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --release --all-features --target=${{ matrix.job.target }}
+          use-cross: true  
+
+      # - name: Run tests
+      #   run: cargo test --verbose
+
+      - name: Publish Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: binaries-${{ matrix.job.name }}
+          path: |
+            target/${{ matrix.job.target }}/release/hbbr
+            target/${{ matrix.job.target }}/release/hbbs
+          if-no-files-found: error
+
+  # github (draft) release with all binaries
+  release:
+
+    name: Github release
+    needs: build
+    runs-on: ubuntu-22.04
+
+    steps:
+
+      - name: Download binaries (amd64)
+        uses: actions/download-artifact@v3
+        with:
+          name: binaries-amd64
+          path: amd64
+
+      - name: Download binaries (arm64v8)
+        uses: actions/download-artifact@v3
+        with:
+          name: binaries-arm64v8
+          path: arm64v8
+
+      - name: Download binaries (armv7)
+        uses: actions/download-artifact@v3
+        with:
+          name: binaries-armv7
+          path: armv7
+
+      - name: Download binaries (i386)
+        uses: actions/download-artifact@v3
+        with:
+          name: binaries-i386
+          path: i386
+
+      - name: Rename files
+        run: for arch in amd64 arm64v8 armv7 i386 ; do for b in hbbr hbbs ; do mv -v ${arch}/${b} ${arch}/${b}-${arch} ; done ; done 
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        with:
+          draft: true
+          files: |
+            amd64/*
+            arm64v8/*
+            armv7/*
+            i386/*
+            
+  # docker build and push of single-arch images
+  docker:
+
+    name: Docker push - ${{ matrix.job.name }}
+    needs: build
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        job:
+          - { name: "amd64",   docker_platform: "linux/amd64" }
+          - { name: "arm64v8", docker_platform: "linux/arm64" }
+          - { name: "armv7",   docker_platform: "linux/arm/v7" }
+          - { name: "i386",    docker_platform: "linux/386" }
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        
+      - name: Download binaries
+        uses: actions/download-artifact@v3
+        with:
+          name: binaries-${{ matrix.job.name }}
+          path: docker/rootfs/usr/bin
+
+      - name: Make binaries executable
+        run: chmod -v a+x docker/rootfs/usr/bin/*
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Log in to Docker Hub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+        
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: registry.hub.docker.com/${{ secrets.DOCKER_IMAGE }}
+
+      - name: Get git tag
+        id: vars
+        run: |
+          T=${GITHUB_REF#refs/*/}
+          M=${T%%.*}
+          echo "GIT_TAG=$T" >> $GITHUB_ENV
+          echo "MAJOR_TAG=$M" >> $GITHUB_ENV
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: "./docker"
+          platforms: ${{ matrix.job.docker_platform }}
+          push: true
+          tags: |
+            ${{ secrets.DOCKER_IMAGE }}:${{ env.LATEST_TAG }}-${{ matrix.job.name }}
+            ${{ secrets.DOCKER_IMAGE }}:${{ env.GIT_TAG }}-${{ matrix.job.name }}
+            ${{ secrets.DOCKER_IMAGE }}:${{ env.MAJOR_TAG }}-${{ matrix.job.name }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  # docker build and push of multiarch images
+  docker-manifest:
+
+    name: Docker manifest
+    needs: docker
+    runs-on: ubuntu-22.04
+
+    steps:
+
+      - name: Log in to Docker Hub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Get git tag
+        id: vars
+        run: |
+          T=${GITHUB_REF#refs/*/}
+          M=${T%%.*}
+          echo "GIT_TAG=$T" >> $GITHUB_ENV
+          echo "MAJOR_TAG=$M" >> $GITHUB_ENV
+
+      # manifest for :1.2.3 tag
+      - name: Create and push manifest
+        uses: Noelware/docker-manifest-action@master
+        with:
+          base-image: ${{ secrets.DOCKER_IMAGE }}:${{ env.GIT_TAG }}
+          extra-images: ${{ secrets.DOCKER_IMAGE }}:${{ env.GIT_TAG }}-amd64,${{ secrets.DOCKER_IMAGE }}:${{ env.GIT_TAG }}-arm64v8,${{ secrets.DOCKER_IMAGE }}:${{ env.GIT_TAG }}-armv7,${{ secrets.DOCKER_IMAGE }}:${{ env.GIT_TAG }}-i386
+          push: true
+
+      # manifest for :1 tag (major release)
+      - name: Create and push manifest
+        uses: Noelware/docker-manifest-action@master
+        with:
+          base-image: ${{ secrets.DOCKER_IMAGE }}:${{ env.MAJOR_TAG }}
+          extra-images: ${{ secrets.DOCKER_IMAGE }}:${{ env.MAJOR_TAG }}-amd64,${{ secrets.DOCKER_IMAGE }}:${{ env.MAJOR_TAG }}-arm64v8,${{ secrets.DOCKER_IMAGE }}:${{ env.MAJOR_TAG }}-armv7,${{ secrets.DOCKER_IMAGE }}:${{ env.MAJOR_TAG }}-i386
+          push: true
+
+      # manifest for :latest tag
+      - name: Create and push manifest
+        uses: Noelware/docker-manifest-action@master
+        with:
+          base-image: ${{ secrets.DOCKER_IMAGE }}:${{ github.ref_name }}
+          extra-images: ${{ secrets.DOCKER_IMAGE }}:${{ github.ref_name }}-amd64,${{ secrets.DOCKER_IMAGE }}:${{ github.ref_name }}-arm64v8,${{ secrets.DOCKER_IMAGE }}:${{ github.ref_name }}-armv7,${{ secrets.DOCKER_IMAGE }}:${{ github.ref_name }}-i386
+          push: true
+
+      - name: Create and push manifest
+        uses: Noelware/docker-manifest-action@master
+        with:
+          base-image: ${{ secrets.DOCKER_IMAGE }}:${{ env.LATEST_TAG }}
+          extra-images: ${{ secrets.DOCKER_IMAGE }}:${{ env.LATEST_TAG }}-amd64,${{ secrets.DOCKER_IMAGE }}:${{ env.LATEST_TAG }}-arm64v8,${{ secrets.DOCKER_IMAGE }}:${{ env.LATEST_TAG }}-armv7,${{ secrets.DOCKER_IMAGE }}:${{ env.LATEST_TAG }}-i386
+          push: true
+
+
+            
+  # docker build and push of classic images
+  docker-classic:
+
+    name: Docker push classic - ${{ matrix.job.name }}
+    needs: build
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        job:
+          - { name: "amd64",   docker_platform: "linux/amd64", tag: "latest" }
+          - { name: "arm64v8", docker_platform: "linux/arm64", tag: "latest-arm64v8" }
+
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v3
+        
+      - name: Download binaries
+        uses: actions/download-artifact@v3
+        with:
+          name: binaries-${{ matrix.job.name }}
+          path: docker-classic/
+
+      - name: Make binaries executable
+        run: chmod -v a+x docker-classic/hbb*
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Log in to Docker Hub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+        
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: registry.hub.docker.com/${{ secrets.DOCKER_IMAGE_CLASSIC }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: "./docker-classic"
+          platforms: ${{ matrix.job.docker_platform }}
+          push: true
+          tags: |
+            ${{ secrets.DOCKER_IMAGE_CLASSIC }}:${{ matrix.job.tag }}
+          labels: ${{ steps.meta.outputs.labels }}
--- a/README.md
+++ b/README.md
@ -1,25 +1,161 @@
 # RustDesk Server Program

+[![build](https://github.com/rustdesk/rustdesk-server/actions/workflows/build.yaml/badge.svg)](https://github.com/rustdesk/rustdesk-server/actions/workflows/build.yaml)
+
 [**Download**](https://github.com/rustdesk/rustdesk-server/releases)

-[**Manual**](https://rustdesk.com/docs/en/self-host/) 
+[**Manual**](https://rustdesk.com/docs/en/self-host/)

 [**FAQ**](https://github.com/rustdesk/rustdesk/wiki/FAQ)

 Self-host your own RustDesk server, it is free and open source.

+## How to build manually
+
 ```bash
 cargo build --release
 ```

 Two executables will be generated in target/release.
-  - hbbs - RustDesk ID/Rendezvous server
-  - hbbr - RustDesk relay server
+
+- hbbs - RustDesk ID/Rendezvous server
+- hbbr - RustDesk relay server
+
+You can find updated binaries on the [releases](https://github.com/rustdesk/rustdesk-server/releases) page.

 If you wanna develop your own server, [rustdesk-server-demo](https://github.com/rustdesk/rustdesk-server-demo) might be a better and simpler start for you than this repo.

-## docker-compose
+## Docker images

-If you have Docker and would like to use it, an included `docker-compose.yml` file is included. Edit line 16 to point to your relay server (the one listening on port 21117). You can also edit the volume lines (L18 and L33) if you need.
+Docker images are automatically generated and published on every github release. We have 2 kind of images.
+
+### Classic image
+
+These images are build against `ubuntu-20.04` with the only addition of the binaries (both hbbr and hbbs). They're available on [Docker hub](https://hub.docker.com/r/rustdesk/rustdesk-server/) with these tags:
+
+| architecture | image:tag |
+| --- | --- |
+| amd64 | `rustdesk/rustdesk-server:latest` |
+| arm64v8 | `rustdesk/rustdesk-server:latest-arm64v8` |
+
+You can start these images directly with `docker run` with these commands:
+
+```bash
+docker run --name hbbs -p 21115:21115 -p 21116:21116 -p 21116:21116/udp -p 21118:21118 -v "$PWD:/root" -d rustdesk/rustdesk-server:latest hbbs -r <relay-server-ip[:port]> 
+docker run --name hbbr -p 21117:21117 -p 21119:21119 -v "$PWD:/root" -d rustdesk/rustdesk-server:latest hbbr 
+```
+
+The `relay-server-ip` parameter is the IP address (or dns name) of the server running these containers. The **optional** `port` parameter has to be used if you use a port different than **21117** for `hbbr`.
+
+You can also use docker-compose, using this configuration as a template:
+
+```yaml
+version: '3'
+
+networks:
+  rustdesk-net:
+    external: false
+
+services:
+  hbbs:
+    container_name: hbbs
+    ports:
+      - 21115:21115
+      - 21116:21116
+      - 21116:21116/udp
+      - 21118:21118
+    image: rustdesk/rustdesk-server:latest
+    command: hbbs -r rustdesk.example.com:21117
+    volumes:
+      - ./hbbs:/root
+    networks:
+      - rustdesk-net
+    depends_on:
+      - hbbr
+    restart: unless-stopped
+
+  hbbr:
+    container_name: hbbr
+    ports:
+      - 21117:21117
+      - 21119:21119
+    image: rustdesk/rustdesk-server:latest
+    command: hbbr
+    volumes:
+      - ./hbbr:/root
+    networks:
+      - rustdesk-net
+    restart: unless-stopped
+```
+
+Edit line 16 to point to your relay server (the one listening on port 21117). You can also edit the volume lines (L18 and L33) if you need.

 (docker-compose credit goes to @lukebarone and @QuiGonLeong)
+
+## S6-overlay based images
+
+These images are build against `busybox:stable` with the addition of the binaries (both hbbr and hbbs) and [S6-overlay](https://github.com/just-containers/s6-overlay). They're available on [Docker hub](https://hub.docker.com/r/rustdesk/rustdesk-server-36/) with these tags:
+
+| architecture | version | image:tag |
+| --- | --- | --- |
+| multiarch | latest | `rustdesk/rustdesk-server-s6:latest` |
+| amd64 | latest | `rustdesk/rustdesk-server-s6:latest-amd64` |
+| i386 | latest | `rustdesk/rustdesk-server-s6:latest-i386` |
+| arm64v8 | latest | `rustdesk/rustdesk-server-s6:latest-arm64v8` |
+| armv7 | latest | `rustdesk/rustdesk-server-s6:latest-armv7` |
+| multiarch | 2 | `rustdesk/rustdesk-server-s6:2` |
+| amd64 | 2 | `rustdesk/rustdesk-server-s6:2-amd64` |
+| i386 | 2 | `rustdesk/rustdesk-server-s6:2-i386` |
+| arm64v8 | 2 | `rustdesk/rustdesk-server-s6:2-arm64v8` |
+| armv7 | 2 | `rustdesk/rustdesk-server-s6:2-armv7` |
+| multiarch | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0` |
+| amd64 | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0-amd64` |
+| i386 | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0-i386` |
+| arm64v8 | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0-arm64v8` |
+| armv7 | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0-armv7` |
+
+You're strongly encuraged to use the `multiarch` image either with the `major version` or `latest` tag.
+
+The S6-overlay acts as a supervisor and keeps both process running, so with this image there's no need to have two separate running containers.
+
+You can start these images directly with `docker run` with this command:
+
+```bash
+docker run --name rustdesk-server \
+  -p 21115:21115 -p 21116:21116 -p 21116:21116/udp \
+  -p 21117:21117 -p 21118:21118 -p 21119:21119 \
+  -e "RELAY=rustdeskrelay.example.com" \
+  -e "ENCRYPTED_ONLY=1" \
+  -v "$PWD/data:/data" -d rustdesk/rustdesk-server-s6:latest
+```
+
+Or you can use a docker-compose file:
+
+```yaml
+version: '3'
+
+services:
+  rustdesk-server:
+    container_name: rustdesk-server
+    ports:
+      - 21115:21115
+      - 21116:21116
+      - 21116:21116/udp
+      - 21117:21117
+      - 21118:21118
+      - 21119:21119
+    image: rustdesk/rustdesk-server-s6:latest
+    environment:
+      - "RELAY=rustdesk.example.com:21117"
+      - "ENCRYPTED_ONLY=1"
+    volumes:
+      - ./data:/data
+    restart: unless-stopped
+```
+
+We use these environment variables:
+
+| variable | optional | description |
+| --- | --- | --- |
+| RELAY | no | the IP address/DNS name of the machine running this container |
+| ENCRYPTED_ONLY | yes | if set to **"1"** unencrypted connection will not be accepted |
--- a/docker-classic/Dockerfile
+++ b/docker-classic/Dockerfile
@ -0,0 +1,4 @@
+FROM ubuntu:20.04    
+COPY hbbs /usr/bin/hbbs    
+COPY hbbr /usr/bin/hbbr    
+WORKDIR /root 
--- a/docker/Dockerfile
+++ b/docker/Dockerfile
@ -1,11 +1,3 @@
-FROM rust:alpine AS builder
-
-RUN \
-  apk -U add musl-dev git file make && \
-  git clone --depth=1 https://github.com/rustdesk/rustdesk-server.git /src && \
-  cd /src && \
-  cargo build -r --manifest-path /src/Cargo.toml
-
 FROM busybox:stable

 ARG S6_OVERLAY_VERSION=3.1.0.1
@ -17,11 +9,9 @@ RUN \
  rm /tmp/s6-overlay*.tar.xz
  
 COPY rootfs /
-COPY --from=builder /src/target/release/hbbr /usr/bin/hbbr
-COPY --from=builder /src/target/release/hbbs /usr/bin/hbbs
-COPY healthcheck.sh /usr/bin/healthcheck.sh

 ENV RELAY relay.example.com
+ENV ENCRYPTED_ONLY 0

 EXPOSE 21115 21116 21116/udp 21117 21118 21119

--- a/docker/rootfs/etc/s6-overlay/s6-rc.d/hbbs/run
+++ b/docker/rootfs/etc/s6-overlay/s6-rc.d/hbbs/run
@ -1,3 +1,5 @@
-#!/command/execlineb -P
-posix-cd /data
-/usr/bin/hbbs -r $RELAY
+#!/command/with-contenv sh
+cd /data
+PARAMS=
+[ "${ENCRYPTED_ONLY}" = "1" ] && PARAMS="-k _"
+/usr/bin/hbbs -r $RELAY $PARAMS
--- a/docker/rootfs/usr/bin/healthcheck.sh
+++ b/docker/rootfs/usr/bin/healthcheck.sh
@ -0,0 +1,4 @@
+#!/bin/sh
+
+/package/admin/s6/command/s6-svstat /run/s6-rc/servicedirs/hbbr || exit 1
+/package/admin/s6/command/s6-svstat /run/s6-rc/servicedirs/hbbs || exit 1