aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorLuke Barone <[email protected]>2022-05-25 09:53:34 -0700
committerLuke Barone <[email protected]>2022-05-25 09:53:34 -0700
commit063b4543682815bbd6fa329f3c977c00c6b1475f (patch)
tree16313cd86af137c46404b094bb95686016f3ede4 /README.md
parentb5c71109b02c9d1d71947b27a63c8b96b561bfe1 (diff)
downloadrustdesk-server-063b4543682815bbd6fa329f3c977c00c6b1475f.tar.gz
rustdesk-server-063b4543682815bbd6fa329f3c977c00c6b1475f.zip
Updated readme; added docker-compose
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index f97831c..cdff863 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,12 @@
# RustDesk Server Program
-
-
[**Download**](https://github.com/rustdesk/rustdesk-server/releases)
[**Manual**](https://rustdesk.com/docs/en/self-host/)
Self-host your own RustDesk server, it is free and open source.
-```
+```bash
cargo build --release
```
@@ -17,3 +15,9 @@ Two executables will be generated in target/release.
- hbbr - RustDesk relay server
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
+
+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-compose credit goes to @lukebarone and @QuiGonLeong)