Skip to content

Commit

Permalink
Merge pull request #415 from Mr-Update/patch-1
Browse files Browse the repository at this point in the history
Small corrections
  • Loading branch information
rustdesk authored Jul 22, 2024
2 parents 8d2a87b + 88bfe35 commit 240d7ac
Show file tree
Hide file tree
Showing 11 changed files with 64 additions and 77 deletions.
3 changes: 1 addition & 2 deletions content/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,4 @@ Open source Server Repository: https://github.com/rustdesk/rustdesk-server</br>
Pro Server Repository: https://github.com/rustdesk/rustdesk-server-pro</br>
Doc Repository: https://github.com/rustdesk/doc.rustdesk.com</br>

{{% children depth="3" showhidden="true" %}}

{{% children depth="4" showhidden="true" %}}
2 changes: 1 addition & 1 deletion content/self-host/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ For Pro users without an SSL Proxy you will need to open TCP port `21114` for th

To check ports are opened and working you can use `test-netconnection domain.com -p 21115` with PowerShell or [CanYouSeeMe.org](https://canyouseeme.org/).

{{% children depth="3" showhidden="true" %}}
{{% children depth="4" showhidden="true" %}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Advanced Settings
weight: 49
---

All adavanced settings in custom clients are covered here.
All advanced settings in custom clients are covered here.

## Privilege Levels for Settings

Expand Down Expand Up @@ -46,7 +46,7 @@ Enable keyboard/mouse input for incoming connections.

### enable-clipboard

Enable copy and paste for the incoming connections.
Enable copy and paste for incoming connections.

**Location**:

Expand Down Expand Up @@ -331,7 +331,7 @@ The directory to save recorded videos.

Default values:

1. **MacOS** ~/Movies/**app_name**
1. **macOS** ~/Movies/**app_name**
2. **Linux** ~/Videos/**app_name**
3. **Windows** %USERPROFILE%\Videos\\**app_name**
4. **Android** /Storage/emulated/0/**app_name**/ScreenRecord
Expand Down Expand Up @@ -568,7 +568,7 @@ This option will set the "follow-remote-cursor" option for every peer after the

Then the "follow-remote-cursor" option in each peer's settings will controls whether to follow the remote cursor.

**Preview** [PR 7717](https://github.com/rustdesk/rustdesk/pull/7717)
**Preview**: [PR 7717](https://github.com/rustdesk/rustdesk/pull/7717)

**Location**:

Expand All @@ -585,7 +585,7 @@ This option will set the "follow-remote-window" option for every peer after the

Then the "follow-remote-window" option in each peer's settings will controls whether to follow the remote window.

**Preview** [PR 7717](https://github.com/rustdesk/rustdesk/pull/7717)
**Preview**: [PR 7717](https://github.com/rustdesk/rustdesk/pull/7717)

**Location**:

Expand Down Expand Up @@ -767,7 +767,7 @@ This option will set the "displays-as-individual-windows" option for every peer

The "displays-as-individual-windows" option in each peer's settings will then control whether to show displays as individual windows.

**Preview** [PR 5945](https://github.com/rustdesk/rustdesk/pull/5945)
**Preview**: [PR 5945](https://github.com/rustdesk/rustdesk/pull/5945)

**Location**:

Expand All @@ -784,7 +784,7 @@ This option will set the "use-all-my-displays-for-the-remote_session" option for

The "use-all-my-displays-for-the-remote_session" option in each peer's settings will then control whether to use all my displays for the remote session.

**Preview** [PR 6064](https://github.com/rustdesk/rustdesk/pull/6064)
**Preview**: [PR 6064](https://github.com/rustdesk/rustdesk/pull/6064)

**Location**:

Expand Down Expand Up @@ -885,7 +885,7 @@ The "codec-preference" option in each peer's settings will then control codec fo
| :------: | :------: | :------: | :------: |
| N | auto, vp8, vp9, av1, h264, h265 | auto | `codec-preference=auto` |

**CAUTION**: Options other than "vp8" and "vp9" may not work. This depends on what your machine supports.
**Caution**: Options other than "vp8" and "vp9" may not work. This depends on what your machine supports.

### preset-address-book-name & preset-address-book-tag

Expand All @@ -898,24 +898,22 @@ Please use valid address book name and tag on your address book page of web cons
| preset-address-book-name | N | | | `preset-address-book-name=<address book name>` |
| preset-address-book-tag | N | | | `preset-address-book-tag=<address book tag name>` |


### disable-group-panel

Disable group panel (next to address book panel) on RustDesk client, https://github.com/rustdesk/rustdesk-server-pro/issues/250
Disable group panel (next to address book panel) on RustDesk client, https://github.com/rustdesk/rustdesk-server-pro/issues/250.

| Option | Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: | :------: |
| disable-group-panel | N | Y, N | N | `disable-group-panel=Y` |

### pre-elevate-service

Automatic elevation on run for Windows portable, https://github.com/rustdesk/rustdesk-server-pro/issues/252
Automatic elevation on run for Windows portable, https://github.com/rustdesk/rustdesk-server-pro/issues/252.

| Option | Install required | Values | Default | Example |
| :------: | :------: | :------: | :------: | :------: |
| pre-elevate-service | N | Y, N | N | `pre-elevate-service=Y` |


### disable-floating-window

When the Android service starts, it will display a floating window, which helps prevent the system from killing the RustDesk service.
Expand Down Expand Up @@ -951,7 +949,7 @@ Android floating windows have adjustable transparency. If you want to enable but
### floating-window-svg

If an icon is not set for the Android floating window, it will default to displaying the RustDesk icon.
When setting, please write the text content of svg into one line, and pay attention to [the svg support limitations](https://bigbadaboom.github.io/androidsvg/index.html)
When setting, please write the text content of SVG into one line, and pay attention to the [SVG support limitations](https://bigbadaboom.github.io/androidsvg/index.html).

| Default | Example |
| :------: | :------: |
Expand Down Expand Up @@ -983,18 +981,17 @@ This is for the Android controlled side. By default, when the resolution is grea

### allow-remote-cm-modification

Whether to allow the control side to click on the connection management window to accept connections, change permissions, etc.
Controls whether to allow the control side to click on the connection management window to accept connections, change permissions, etc.

https://github.com/rustdesk/rustdesk/issues/7425

| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | N | `allow-remote-cm-modification=Y` |


### remove-preset-password-warning

Whether to remove the security warning on GUI when there is preset password in custom client.
Controls whether to remove the security warning on GUI when there is preset password in custom client.

https://github.com/rustdesk/rustdesk-server-pro/discussions/286

Expand All @@ -1006,7 +1003,7 @@ https://github.com/rustdesk/rustdesk/discussions/7956

### hide-security-settings / hide-network-settings / hide-server-settings / hide-proxy-settings

Whether to hide some settings, please ensure `Disable settings` is turned off, otherwise these won't work.
Controls whether to hide some settings. Please ensure `Disable settings` is turned off, otherwise these won't work.

https://github.com/rustdesk/rustdesk-server-pro/issues/263

Expand All @@ -1018,7 +1015,7 @@ https://github.com/rustdesk/rustdesk-server-pro/issues/276

### hide-username-on-card

Whether to show username in the list of devices, because sometimes, the username is too long, will hide the other info.
Controls whether to show username in the list of devices. Because sometimes, the username is too long, will hide the other info.

https://github.com/rustdesk/rustdesk-server-pro/issues/284#issuecomment-2216521407

Expand All @@ -1028,7 +1025,7 @@ https://github.com/rustdesk/rustdesk-server-pro/issues/284#issuecomment-22165214

### hide-help-cards

Whether to show UAC / permission warnings on GUI.
Controls whether to show UAC / permission warnings on GUI.

https://github.com/rustdesk/rustdesk/issues/8687

Expand All @@ -1044,17 +1041,14 @@ https://github.com/rustdesk/rustdesk-server-pro/issues/277

### disable-udp

Whether to use TCP only, it will not use UDP 21116 any more, TCP 21116 will be used instead.
Controls whether to use TCP only. It will not use UDP 21116 any more, TCP 21116 will be used instead.

| Values | Default | Example |
| :------: | :------: | :------: |
| Y, N | N | `disable-udp=Y` |


### preset-user-name / preset-strategy-name

Assign user / strategy to device, you can also do this via [command line](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/#assign-device-usersgroupsstrategies-to-devices)
Assign user / strategy to device. You can also do this via [command line](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/console/#assign-device-usersgroupsstrategies-to-devices).

https://github.com/rustdesk/rustdesk-server-pro/discussions/304


18 changes: 9 additions & 9 deletions content/self-host/client-deployment/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ function getLatest()
$HTML.write($src)
}
# Current example link: https://github.com/rustdesk/rustdesk/releases/download/1.2.3/rustdesk-1.2.3-x86_64.exe
# Current example link: https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-x86_64.exe
$Downloadlink = ($HTML.Links | Where {$_.href -match '(.)+\/rustdesk\/rustdesk\/releases\/download\/\d{1}.\d{1,2}.\d{1,2}(.{0,3})\/rustdesk(.)+x86_64.exe'} | select -first 1).href
# bugfix - sometimes you need to replace "about:"
Expand Down Expand Up @@ -156,7 +156,7 @@ REM ############################### Please Do Not Edit Below This Line #########
if not exist C:\Temp\ md C:\Temp\
cd C:\Temp\
curl -L "https://github.com/rustdesk/rustdesk/releases/download/1.2.3/rustdesk-1.2.3-x86_64.exe" -o rustdesk.exe
curl -L "https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-x86_64.exe" -o rustdesk.exe
rustdesk.exe --silent-install
timeout /t 20
Expand Down Expand Up @@ -200,7 +200,7 @@ if [[ $EUID -ne 0 ]]; then
fi

# Specify the path to the rustdesk.dmg file
dmg_file="/tmp/rustdesk-1.2.3-x86_64.dmg"
dmg_file="/tmp/rustdesk-1.2.6-x86_64.dmg"

# Specify the mount point for the DMG (temporary directory)
mount_point="/Volumes/RustDesk"
Expand All @@ -209,9 +209,9 @@ mount_point="/Volumes/RustDesk"
echo "Downloading RustDesk Now"

if [[ $(arch) == 'arm64' ]]; then
curl -L https://github.com/rustdesk/rustdesk/releases/download/1.2.3/rustdesk-1.2.3-aarch64.dmg --output "$dmg_file"
curl -L https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-aarch64.dmg --output "$dmg_file"
else
curl -L https://github.com/rustdesk/rustdesk/releases/download/1.2.3/rustdesk-1.2.3-x86_64.dmg --output "$dmg_file"
curl -L https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-x86_64.dmg --output "$dmg_file"
fi

# Mount the DMG file to the specified mount point
Expand Down Expand Up @@ -323,11 +323,11 @@ fi

echo "Installing RustDesk"
if [ "${ID}" = "debian" ] || [ "$OS" = "Ubuntu" ] || [ "$OS" = "Debian" ] || [ "${UPSTREAM_ID}" = "ubuntu" ] || [ "${UPSTREAM_ID}" = "debian" ]; then
wget https://github.com/rustdesk/rustdesk/releases/download/1.2.3/rustdesk-1.2.3-x86_64.deb
apt-get install -fy ./rustdesk-1.2.3-x86_64.deb > null
wget https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-x86_64.deb
apt-get install -fy ./rustdesk-1.2.6-x86_64.deb > null
elif [ "$OS" = "CentOS" ] || [ "$OS" = "RedHat" ] || [ "$OS" = "Fedora Linux" ] || [ "${UPSTREAM_ID}" = "rhel" ] || [ "$OS" = "Almalinux" ] || [ "$OS" = "Rocky*" ] ; then
wget https://github.com/rustdesk/rustdesk/releases/download/1.2.3/rustdesk-1.2.3-0.x86_64.rpm
yum localinstall ./rustdesk-1.2.3-0.x86_64.rpm -y > null
wget https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-0.x86_64.rpm
yum localinstall ./rustdesk-1.2.6-0.x86_64.rpm -y > null
else
echo "Unsupported OS"
# here you could ask the user for permission to try and install anyway
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ if (!(Test-Path C:\Temp))
cd C:\Temp
Invoke-WebRequest "https://github.com/rustdesk/rustdesk/releases/download/1.2.3/rustdesk-1.2.3-x86_64.exe" -Outfile "rustdesk.exe"
Invoke-WebRequest "https://github.com/rustdesk/rustdesk/releases/download/1.2.6/rustdesk-1.2.6-x86_64.exe" -Outfile "rustdesk.exe"
Start-Process .\rustdesk.exe --silent-install -wait
$ServiceName = 'Rustdesk'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ You could modify the line with `hbbs` to your NAS's LAN IP temporarily just like
services:
hbbs:
container_name: hbbs
image: rustdesk/rustdesk-server:latest # please change this to rustdesk/rustdesk-server-pro:latest if you want to install Pro.
image: rustdesk/rustdesk-server:latest # Please change this to rustdesk/rustdesk-server-pro:latest if you want to install Pro.
command: hbbs -r rustdesk.example.com:21117 -k _
volumes:
- ./data:/root
Expand All @@ -51,7 +51,7 @@ services:

hbbr:
container_name: hbbr
image: rustdesk/rustdesk-server:latest # please change this to rustdesk/rustdesk-server-pro:latest if you want to install Pro.
image: rustdesk/rustdesk-server:latest # Please change this to rustdesk/rustdesk-server-pro:latest if you want to install Pro.
command: hbbr -k _
volumes:
- ./data:/root
Expand Down Expand Up @@ -110,4 +110,3 @@ Open these required ports:
* `21116` UDP heartbeat/ID server
* `21117` TCP relay
* `21118/21119` TCP for web socket if you want to run web client

20 changes: 10 additions & 10 deletions content/self-host/rustdesk-server-pro/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If you build you own server on your home/office, and can't connect it through pu

Lowest level VPS is enough for your use case. The server software is not CPU and memory intensive. Our public ID server hosted on a 2 CPU/4 GB Vultr server serves 1.5+ million endpoints.

## Video tutorials
### Video tutorials

There are many video tutorials available online that can guide you through installing the OSS version, https://rustdesk.com/docs/en/self-host/rustdesk-server-oss/install/#video-tutorials.

Expand All @@ -39,7 +39,7 @@ The installation of the Pro version is almost identical, except for the followin
- Different download path and Docker images are required.
- An additional TCP port (21114) is needed for the web console.

## License
### License

You can get license from https://rustdesk.com/pricing.html, check [license](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/) page for more details.

Expand All @@ -66,7 +66,7 @@ Almost the same as [the open source version](https://rustdesk.com/docs/en/self-h

#### Docker Installation

Most users choose to install RustDesk server Pro with [Docker](/docs/en/self-host/rustdesk-server-pro/installscript/docker/)
Most users choose to install RustDesk server Pro with [Docker](/docs/en/self-host/rustdesk-server-pro/installscript/docker/).

#### Ports Required

Expand All @@ -78,16 +78,16 @@ More information about these ports, please check [here](/docs/en/self-host/rustd

This [guide](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq/#there-is-a-new-version-of-rustdesk-server-pro-out-how-can-i-upgrade) covers how to upgrade RustDesk Server Pro from a lower version, addressing different installation methods.

## Setup https for web console
### Setup HTTPS for web console

The simple install script includes https setup, but it may fail or you do not like it, and it can not be used for the other installation methods.
The simple install script includes HTTPS setup, but it may fail or you do not like it. It can not be used for the other installation methods.

Here is a simple tutorial of [manual https setup](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq/#set-up-https-for-web-console-manually)
Here is a simple tutorial of [manual HTTPS setup](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/faq/#set-up-https-for-web-console-manually).

## Migrate to new host and backup / restore
### Migrate to new host and backup / restore

Here is a detailed [tutorial](https://github.com/rustdesk/rustdesk-server-pro/discussions/184)
Here is a detailed [tutorial](https://github.com/rustdesk/rustdesk-server-pro/discussions/184).

## Migrate license
### Migrate license

Please follow [this](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/#invoices-license-retrieval-and-migration)
Please follow this [guide](https://rustdesk.com/docs/en/self-host/rustdesk-server-pro/license/#invoices-license-retrieval-and-migration).
Loading

0 comments on commit 240d7ac

Please sign in to comment.