Browse Source

README: Restructure Container expression; add ghcr; multiple tidy up (#479)

* Update README.md

* make hbbs first everywhere

* Update README.md

* Fix link

* dockerhub to Docker Hub; Suggest user use ghcr if can't access Docker Hub

* Add `

* Add Debian 12
XLion 1 year ago
parent
commit
2f246537df
1 changed files with 38 additions and 34 deletions
  1. 38 34
      README.md

+ 38 - 34
README.md

@@ -32,24 +32,31 @@ Three executables will be generated in target/release.
32 32
 - hbbr - RustDesk relay server
33 33
 - rustdesk-utils - RustDesk CLI utilities
34 34
 
35
-You can find updated binaries on the [releases](https://github.com/rustdesk/rustdesk-server/releases) page.
35
+You can find updated binaries on the [Releases](https://github.com/rustdesk/rustdesk-server/releases) page.
36 36
 
37
-If you want extra features [RustDesk Server Pro](https://rustdesk.com/pricing.html) might suit you better.
37
+If you want extra features, [RustDesk Server Pro](https://rustdesk.com/pricing.html) might suit you better.
38 38
 
39 39
 If you want to 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.
40 40
 
41 41
 ## Docker images
42 42
 
43
-Docker images are automatically generated and published on every github release. We have 2 kind of images.
43
+Docker images are automatically generated and published to [Docker Hub](https://hub.docker.com/r/rustdesk) and [GitHub Container Registry](https://github.com/rustdesk?tab=packages&repo_name=rustdesk-server) on every GitHub release. We have 2 kind of images.
44 44
 
45 45
 ### Classic image
46 46
 
47
-These images are build against `ubuntu-20.04` with the only addition of the main binaries (`hbbr` and `hbbs`). They're available on [Docker hub](https://hub.docker.com/r/rustdesk/rustdesk-server/) with these tags:
47
+These images are built from scratch with two main binaries (`hbbs` and `hbbr`). They're available on [Docker Hub](https://hub.docker.com/r/rustdesk/rustdesk-server/) and [GitHub Container Registry](https://github.com/rustdesk/rustdesk-server/pkgs/container/rustdesk-server) with these architectures:
48
+
49
+* amd64
50
+* arm64v8
51
+* armv7
52
+
53
+You could use `latest` tag or major version tag `1` with supported architectures:
54
+
55
+| Version       | image:tag                         |
56
+| ------------- | --------------------------------- |
57
+| latest        | `rustdesk/rustdesk-server:latest` |
58
+| Major version | `rustdesk/rustdesk-server:1`      |
48 59
 
49
-| architecture | image:tag |
50
-| --- | --- |
51
-| amd64 | `rustdesk/rustdesk-server:latest` |
52
-| arm64v8 | `rustdesk/rustdesk-server:latest-arm64v8` |
53 60
 
54 61
 You can start these images directly with `docker run` with these commands:
55 62
 
@@ -114,34 +121,29 @@ Edit line 16 to point to your relay server (the one listening on port 21117). Yo
114 121
 
115 122
 (docker-compose credit goes to @lukebarone and @QuiGonLeong)
116 123
 
124
+> [!NOTE]  
125
+> The rustdesk/rustdesk-server:latest in China may be replaced with the latest version number on Docker Hub, such as `rustdesk-server:1.1.10-3`. Otherwise, the old version may be pulled due to image acceleration.
117 126
 
118
-> Note that here, the rustdesk/rustdesk-server:latest in China may be replaced with the latest version number on dockerhub, such as rustdesk-server:1.1.10-3. Otherwise, the old version may be pulled due to image acceleration.
127
+> [!NOTE]  
128
+> If you are experiencing issues pulling from Docker Hub, try pulling from the [GitHub Container Registry](https://github.com/rustdesk/rustdesk-server/pkgs/container/rustdesk-server) instead.
119 129
 
120 130
 ## S6-overlay based images
121 131
 
122
-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-s6/) with these tags:
132
+These images are build against `busybox:stable` with the addition of the binaries (both `hbbs` and `hbbr`) and [S6-overlay](https://github.com/just-containers/s6-overlay). They're available on [Docker hub](https://hub.docker.com/r/rustdesk/rustdesk-server-s6/) and [GitHub Container Registry](https://github.com/rustdesk/rustdesk-server/pkgs/container/rustdesk-server) with these architectures:
123 133
 
124
-| architecture | version | image:tag |
125
-| --- | --- | --- |
126
-| multiarch | latest | `rustdesk/rustdesk-server-s6:latest` |
127
-| amd64 | latest | `rustdesk/rustdesk-server-s6:latest-amd64` |
128
-| i386 | latest | `rustdesk/rustdesk-server-s6:latest-i386` |
129
-| arm64v8 | latest | `rustdesk/rustdesk-server-s6:latest-arm64v8` |
130
-| armv7 | latest | `rustdesk/rustdesk-server-s6:latest-armv7` |
131
-| multiarch | 2 | `rustdesk/rustdesk-server-s6:2` |
132
-| amd64 | 2 | `rustdesk/rustdesk-server-s6:2-amd64` |
133
-| i386 | 2 | `rustdesk/rustdesk-server-s6:2-i386` |
134
-| arm64v8 | 2 | `rustdesk/rustdesk-server-s6:2-arm64v8` |
135
-| armv7 | 2 | `rustdesk/rustdesk-server-s6:2-armv7` |
136
-| multiarch | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0` |
137
-| amd64 | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0-amd64` |
138
-| i386 | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0-i386` |
139
-| arm64v8 | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0-arm64v8` |
140
-| armv7 | 2.0.0 | `rustdesk/rustdesk-server-s6:2.0.0-armv7` |
141
-
142
-You're strongly encouraged to use the `multiarch` image either with the `major version` or `latest` tag.
143
-
144
-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.
134
+* amd64
135
+* i386
136
+* arm64v8
137
+* armv7
138
+
139
+You could use `latest` tag or major version tag `1` with supported architectures:
140
+
141
+| Version       | image:tag                            |
142
+| ------------- | ------------------------------------ |
143
+| latest        | `rustdesk/rustdesk-server-s6:latest` |
144
+| Major version | `rustdesk/rustdesk-server-s6:1`      |
145
+
146
+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.
145 147
 
146 148
 You can start these images directly with `docker run` with this command:
147 149
 
@@ -248,7 +250,7 @@ services:
248 250
 #### Use Docker secrets to store the key pair
249 251
 
250 252
 You can alternatively use docker secrets to store the keys.
251
-This is useful if you're using **docker-compose** or **docker swarm**.
253
+This is useful if you're using **docker-compose** or **Docker Swarm**.
252 254
 Just follow this examples:
253 255
 
254 256
 ```bash
@@ -321,18 +323,20 @@ Secret Key:  egAVd44u33ZEUIDTtksGcHeVeAwywarEdHmf99KM5ajwEsuG3NQFT9coAfiZ6nen4hf
321 323
 
322 324
 ## .deb packages
323 325
 
324
-Separate .deb packages are available for each binary, you can find them in the [releases](https://github.com/rustdesk/rustdesk-server/releases).
326
+Separate .deb packages are available for each binary, you can find them in the [Releases](https://github.com/rustdesk/rustdesk-server/releases).
325 327
 These packages are meant for the following distributions:
326 328
 
329
+- Ubuntu 24.04 LTS
327 330
 - Ubuntu 22.04 LTS
328 331
 - Ubuntu 20.04 LTS
329 332
 - Ubuntu 18.04 LTS
333
+- Debian 12 bookworm
330 334
 - Debian 11 bullseye
331 335
 - Debian 10 buster
332 336
 
333 337
 ## ENV variables
334 338
 
335
-hbbs and hbbr can be configured using these ENV variables.
339
+`hbbs` and `hbbr` can be configured using these ENV variables.
336 340
 You can specify the variables as usual or use an `.env` file.
337 341
 
338 342
 | variable | binary | description |