docs: add explicit client deployment instructions#611
Conversation
Signed-off-by: 21pages <sunboeasy@gmail.com>
📝 WalkthroughWalkthroughThis PR adds comprehensive multilingual documentation for a new explicit device deployment feature in RustDesk. The client deployment guide receives a new section across 11 language variants explaining API token setup and platform-specific deployment workflows, while server console documentation is updated to document the corresponding ChangesDevice Deployment Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Caution Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted. Error details |
Signed-off-by: 21pages <sunboeasy@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (9)
content/self-host/client-deployment/_index.es.md (1)
391-391: ⚡ Quick winConsider localizing the API token documentation link.
The link points to
/docs/en/self-host/rustdesk-server-pro/console/#api-token(English) rather than/docs/es/self-host/rustdesk-server-pro/console/#api-token(Spanish). For consistency, consider using the localized link if Spanish documentation is available.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/self-host/client-deployment/_index.es.md` at line 391, Update the API token link in content/self-host/client-deployment/_index.es.md so it points to the Spanish-localized page (use /docs/es/self-host/rustdesk-server-pro/console/#api-token) or make it a relative/localized link resolver; specifically modify the link in the sentence that currently references /docs/en/self-host/rustdesk-server-pro/console/#api-token to the Spanish path to ensure consistency with the .es file.content/self-host/client-deployment/_index.de.md (2)
386-386: ⚡ Quick winConsider localizing the API token documentation link.
The link points to
/docs/en/self-host/rustdesk-server-pro/console/#api-token(English) rather than the German variant/docs/de/self-host/rustdesk-server-pro/console/#api-token. For consistency with the rest of the German documentation, consider using the localized link.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/self-host/client-deployment/_index.de.md` at line 386, The API token link in the German page currently points to the English URL "/docs/en/self-host/rustdesk-server-pro/console/#api-token"; update that hyperlink to the German localized path "/docs/de/self-host/rustdesk-server-pro/console/#api-token" so the "API-Token" link on the page "content/self-host/client-deployment/_index.de.md" uses the localized documentation; ensure the visible link text and anchor "`#api-token`" remain unchanged.
380-416: ⚡ Quick winConsider mentioning minimum version requirements.
Based on the server console documentation, the
--deployparameter requires RustDesk Server Pro 1.8.3 and RustDesk Client 1.4.7. Adding this version information would help users determine whether their deployment supports this feature.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/self-host/client-deployment/_index.de.md` around lines 380 - 416, Add minimum version requirements for the deploy flow: update the section that documents the --deploy parameter and the Android deploy dialog to state that server-side deployment requires RustDesk Server Pro >= 1.8.3 and client-side support requires RustDesk Client >= 1.4.7 (mention both Windows/macOS/Linux CLI usage with rustdesk --deploy --token and the Android "Bereitstellen" dialog). Place this version note near the "## Explizite Bereitstellung für neue Geräte" header or immediately before the usage examples so readers see the RustDesk Server Pro 1.8.3 and RustDesk Client 1.4.7 requirements when reading about the --deploy parameter and Android deployment UI.content/self-host/client-deployment/_index.ja.md (1)
391-391: ⚡ Quick winConsider localizing the API token documentation link.
The link points to
/docs/en/self-host/rustdesk-server-pro/console/#api-token(English) rather than/docs/ja/self-host/rustdesk-server-pro/console/#api-token(Japanese). For consistency, consider using the localized link if Japanese documentation is available.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/self-host/client-deployment/_index.ja.md` at line 391, Replace the hard-coded English docs link `/docs/en/self-host/rustdesk-server-pro/console/#api-token` in the sentence that starts with "サーバーの Web コンソールで管理者アカウントを使用して [API トークン]" with the Japanese-localized path `/docs/ja/self-host/rustdesk-server-pro/console/#api-token`; update the anchor reference in that same line so the API token link points to the localized Japanese documentation.content/self-host/client-deployment/_index.pl.md (1)
391-391: ⚡ Quick winConsider localizing the API token documentation link.
The link points to
/docs/en/self-host/rustdesk-server-pro/console/#api-token(English) rather than/docs/pl/self-host/rustdesk-server-pro/console/#api-token(Polish). For consistency, consider using the localized link if Polish documentation is available.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/self-host/client-deployment/_index.pl.md` at line 391, Update the hardcoded English docs link string "/docs/en/self-host/rustdesk-server-pro/console/#api-token" in the content of content/self-host/client-deployment/_index.pl.md to the Polish localized path "/docs/pl/self-host/rustdesk-server-pro/console/#api-token"; if the Polish page may not exist, use a relative or language-agnostic link pattern (e.g., remove "/en" or "/pl") or add a runtime/localization helper so the API token link resolves to the appropriate language for the current locale.content/self-host/client-deployment/_index.it.md (1)
391-391: ⚡ Quick winConsider localizing the API token documentation link.
The link points to
/docs/en/self-host/rustdesk-server-pro/console/#api-token(English) rather than/docs/it/self-host/rustdesk-server-pro/console/#api-token(Italian). For consistency, consider using the localized link if Italian documentation is available.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/self-host/client-deployment/_index.it.md` at line 391, The documentation link in content/self-host/client-deployment/_index.it.md currently points to the English path "/docs/en/self-host/rustdesk-server-pro/console/#api-token"; update that URL to the Italian localized path "/docs/it/self-host/rustdesk-server-pro/console/#api-token" (or use a relative/localized link pattern used elsewhere) so the API token link in the paragraph about creating a token for RustDesk points to the Italian docs; locate the link string in the sentence that begins "Crea un [token API]" and replace the "/docs/en/" segment with "/docs/it/" (or the project’s localization helper) to ensure consistency.content/self-host/client-deployment/_index.pt.md (1)
391-391: ⚡ Quick winConsider localizing the API token documentation link.
The link points to
/docs/en/self-host/rustdesk-server-pro/console/#api-token(English) rather than/docs/pt/self-host/rustdesk-server-pro/console/#api-token(Portuguese). For consistency, consider using the localized link if Portuguese documentation is available.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/self-host/client-deployment/_index.pt.md` at line 391, Update the hard-coded English API token link by replacing the target "/docs/en/self-host/rustdesk-server-pro/console/#api-token" with the Portuguese localized path "/docs/pt/self-host/rustdesk-server-pro/console/#api-token" (or use the appropriate i18n link helper if the project supports it) so the sentence.links the localized Portuguese documentation instead of the English one.content/self-host/client-deployment/_index.fr.md (1)
391-391: ⚡ Quick winConsider localizing the API token documentation link.
The link points to
/docs/en/self-host/rustdesk-server-pro/console/#api-token(English) rather than/docs/fr/self-host/rustdesk-server-pro/console/#api-token(French). For consistency, consider using the localized link if French documentation is available.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/self-host/client-deployment/_index.fr.md` at line 391, The French page uses an English docs link: update the Markdown link target in the sentence containing "[jeton d'API](/docs/en/self-host/rustdesk-server-pro/console/#api-token)" to the localized French path "/docs/fr/self-host/rustdesk-server-pro/console/#api-token" so the link points to French documentation; locate the "[jeton d'API]" link in content/self-host/client-deployment/_index.fr.md and replace the "/docs/en/..." href with "/docs/fr/..." accordingly.content/self-host/client-deployment/_index.en.md (1)
392-428: ⚡ Quick winConsider adding version requirements for the explicit deployment feature.
The server console documentation indicates that
--deployrequires RustDesk Server Pro 1.8.3 and RustDesk Client 1.4.7. Including this version information would help users verify compatibility before attempting deployment.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@content/self-host/client-deployment/_index.en.md` around lines 392 - 428, Add explicit minimum version notes for the explicit deployment feature: update the "Explicit deployment for new devices" section to state that server-side explicit deployment requires RustDesk Server Pro >= 1.8.3 and the client-side deployment flag (--deploy) requires RustDesk Client >= 1.4.7, and mention compatibility for Android behavior; place this compatibility sentence near the top of the section (before the platform-specific instructions) and reference the commands/examples that use rustdesk --deploy and the Android Deploy dialog so readers can verify they meet the required versions.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@content/self-host/rustdesk-server-pro/console/_index.ja.md`:
- Line 148: The link for `--deploy` in
content/self-host/rustdesk-server-pro/console/_index.ja.md points to the English
anchor /docs/en/self-host/client-deployment/#explicit-deployment-for-new-devices
which may not exist in localized client-deployment pages; either change this
locale file to point to its localized client-deployment anchor (ensure the
localized page in content/self-host/client-deployment/_index.ja.md contains the
matching id for the “explicit deployment” section) or remove/replace the anchor
with a locale-agnostic target (e.g., link to the parent localized page without
the fragment) and apply the same change to other locales’ console _index.*.md
files so links are consistent across `--deploy` references.
---
Nitpick comments:
In `@content/self-host/client-deployment/_index.de.md`:
- Line 386: The API token link in the German page currently points to the
English URL "/docs/en/self-host/rustdesk-server-pro/console/#api-token"; update
that hyperlink to the German localized path
"/docs/de/self-host/rustdesk-server-pro/console/#api-token" so the "API-Token"
link on the page "content/self-host/client-deployment/_index.de.md" uses the
localized documentation; ensure the visible link text and anchor "`#api-token`"
remain unchanged.
- Around line 380-416: Add minimum version requirements for the deploy flow:
update the section that documents the --deploy parameter and the Android deploy
dialog to state that server-side deployment requires RustDesk Server Pro >=
1.8.3 and client-side support requires RustDesk Client >= 1.4.7 (mention both
Windows/macOS/Linux CLI usage with rustdesk --deploy --token and the Android
"Bereitstellen" dialog). Place this version note near the "## Explizite
Bereitstellung für neue Geräte" header or immediately before the usage examples
so readers see the RustDesk Server Pro 1.8.3 and RustDesk Client 1.4.7
requirements when reading about the --deploy parameter and Android deployment
UI.
In `@content/self-host/client-deployment/_index.en.md`:
- Around line 392-428: Add explicit minimum version notes for the explicit
deployment feature: update the "Explicit deployment for new devices" section to
state that server-side explicit deployment requires RustDesk Server Pro >= 1.8.3
and the client-side deployment flag (--deploy) requires RustDesk Client >=
1.4.7, and mention compatibility for Android behavior; place this compatibility
sentence near the top of the section (before the platform-specific instructions)
and reference the commands/examples that use rustdesk --deploy and the Android
Deploy dialog so readers can verify they meet the required versions.
In `@content/self-host/client-deployment/_index.es.md`:
- Line 391: Update the API token link in
content/self-host/client-deployment/_index.es.md so it points to the
Spanish-localized page (use
/docs/es/self-host/rustdesk-server-pro/console/#api-token) or make it a
relative/localized link resolver; specifically modify the link in the sentence
that currently references
/docs/en/self-host/rustdesk-server-pro/console/#api-token to the Spanish path to
ensure consistency with the .es file.
In `@content/self-host/client-deployment/_index.fr.md`:
- Line 391: The French page uses an English docs link: update the Markdown link
target in the sentence containing "[jeton
d'API](/docs/en/self-host/rustdesk-server-pro/console/#api-token)" to the
localized French path
"/docs/fr/self-host/rustdesk-server-pro/console/#api-token" so the link points
to French documentation; locate the "[jeton d'API]" link in
content/self-host/client-deployment/_index.fr.md and replace the "/docs/en/..."
href with "/docs/fr/..." accordingly.
In `@content/self-host/client-deployment/_index.it.md`:
- Line 391: The documentation link in
content/self-host/client-deployment/_index.it.md currently points to the English
path "/docs/en/self-host/rustdesk-server-pro/console/#api-token"; update that
URL to the Italian localized path
"/docs/it/self-host/rustdesk-server-pro/console/#api-token" (or use a
relative/localized link pattern used elsewhere) so the API token link in the
paragraph about creating a token for RustDesk points to the Italian docs; locate
the link string in the sentence that begins "Crea un [token API]" and replace
the "/docs/en/" segment with "/docs/it/" (or the project’s localization helper)
to ensure consistency.
In `@content/self-host/client-deployment/_index.ja.md`:
- Line 391: Replace the hard-coded English docs link
`/docs/en/self-host/rustdesk-server-pro/console/#api-token` in the sentence that
starts with "サーバーの Web コンソールで管理者アカウントを使用して [API トークン]" with the
Japanese-localized path
`/docs/ja/self-host/rustdesk-server-pro/console/#api-token`; update the anchor
reference in that same line so the API token link points to the localized
Japanese documentation.
In `@content/self-host/client-deployment/_index.pl.md`:
- Line 391: Update the hardcoded English docs link string
"/docs/en/self-host/rustdesk-server-pro/console/#api-token" in the content of
content/self-host/client-deployment/_index.pl.md to the Polish localized path
"/docs/pl/self-host/rustdesk-server-pro/console/#api-token"; if the Polish page
may not exist, use a relative or language-agnostic link pattern (e.g., remove
"/en" or "/pl") or add a runtime/localization helper so the API token link
resolves to the appropriate language for the current locale.
In `@content/self-host/client-deployment/_index.pt.md`:
- Line 391: Update the hard-coded English API token link by replacing the target
"/docs/en/self-host/rustdesk-server-pro/console/#api-token" with the Portuguese
localized path "/docs/pt/self-host/rustdesk-server-pro/console/#api-token" (or
use the appropriate i18n link helper if the project supports it) so the
sentence.links the localized Portuguese documentation instead of the English
one.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: d8d92cde-d52c-48cc-8d19-ed0dfcb556f9
📒 Files selected for processing (22)
content/self-host/client-deployment/_index.de.mdcontent/self-host/client-deployment/_index.en.mdcontent/self-host/client-deployment/_index.es.mdcontent/self-host/client-deployment/_index.fr.mdcontent/self-host/client-deployment/_index.it.mdcontent/self-host/client-deployment/_index.ja.mdcontent/self-host/client-deployment/_index.pl.mdcontent/self-host/client-deployment/_index.pt.mdcontent/self-host/client-deployment/_index.ro.mdcontent/self-host/client-deployment/_index.zh-cn.mdcontent/self-host/client-deployment/_index.zh-tw.mdcontent/self-host/rustdesk-server-pro/console/_index.de.mdcontent/self-host/rustdesk-server-pro/console/_index.en.mdcontent/self-host/rustdesk-server-pro/console/_index.es.mdcontent/self-host/rustdesk-server-pro/console/_index.fr.mdcontent/self-host/rustdesk-server-pro/console/_index.it.mdcontent/self-host/rustdesk-server-pro/console/_index.ja.mdcontent/self-host/rustdesk-server-pro/console/_index.pl.mdcontent/self-host/rustdesk-server-pro/console/_index.pt.mdcontent/self-host/rustdesk-server-pro/console/_index.ro.mdcontent/self-host/rustdesk-server-pro/console/_index.zh-cn.mdcontent/self-host/rustdesk-server-pro/console/_index.zh-tw.md
| | `--note <note>` | デバイスにメモを追加 | 1.6.6 | 1.4.3 | | ||
| | `--device_username <device_username>` | デバイスのユーザー名を設定 | 1.6.6 | 1.4.3 | | ||
| | `--device_name <device_name>` | デバイス名を設定 | 1.6.6 | 1.4.3 | | ||
| | [`--deploy`](/docs/en/self-host/client-deployment/#explicit-deployment-for-new-devices) | **新しいデバイスにデプロイを必須にする** が有効な場合に、新しいデバイスを登録します。**Devices** 権限が **Read and write** に設定された API トークンが必要です。 | 1.8.3 | 1.4.7 | |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if localized client-deployment pages exist for these locales
for locale in ja pl pt ro zh-cn zh-tw; do
echo "=== Checking $locale ==="
fd -t f "client-deployment.*\.$locale\.md" content/self-host/
done
# Check if other cross-references in these console docs use localized or English paths
echo "=== Sample of existing links in Japanese console doc ==="
rg "]\(/docs/(en|ja)/" content/self-host/rustdesk-server-pro/console/_index.ja.md | head -5Repository: rustdesk/doc.rustdesk.com
Length of output: 620
🏁 Script executed:
#!/bin/bash
set -euo pipefail
ROOT="content/self-host"
DOC="rustdesk-server-pro/console"
echo "=== Find any client-deployment pages under ${ROOT} ==="
fd -t f "client-deployment*.md" "$ROOT" | sort | head -50
echo "=== Search for explicit-deployment-for-new-devices anchor in markdown ==="
rg -n "explicit-deployment-for-new-devices" "$ROOT" | head -50
echo "=== Check if any locale links to Japanese/Chinese client-deployment exist in repo ==="
rg -n "/docs/(ja|zh-cn|zh-tw|pl|pt|ro)/self-host/client-deployment" content | head -50
echo "=== Inspect deploy links in other locale console index pages ==="
fd -t f "_index\.(ja|zh-cn|zh-tw|pl|pt|ro)\.md" "content/self-host/$DOC" | sort | while read -r f; do
echo "--- $f ---"
rg -n "\\[\\`--deploy\\`\\]\\(/docs/(en|ja|zh-cn|zh-tw|pl|pt|ro)/self-host/client-deployment/#explicit-deployment-for-new-devices" "$f" || true
doneRepository: rustdesk/doc.rustdesk.com
Length of output: 6953
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Look for localized index files under client-deployment
for locale in ja zh-cn zh-tw pl pt ro it de fr es; do
echo "=== locale: $locale ==="
fd -t f "_index\\.${locale}\\.md" "content/self-host/client-deployment" || true
done
echo "=== any client-deployment localized files under content/self-host ==="
fd -t f "client-deployment" content/self-host | head -50Repository: rustdesk/doc.rustdesk.com
Length of output: 831
🏁 Script executed:
#!/bin/bash
set -euo pipefail
TARGET_DIR="content/self-host/client-deployment"
for locale in en ja zh-cn zh-tw pl pt ro it de fr es; do
echo "=== locale: $locale ==="
# Search anchor text in each page if it exists
file="$TARGET_DIR/_index.${locale}.md"
if [ -f "$file" ]; then
rg -n "explicit-deployment-for-new-devices" "$file" || true
else
# en may not have _index.en.md; search any en-like fallback
rg -n "explicit-deployment-for-new-devices" "$TARGET_DIR" || true
fi
done
echo "=== quick: how many occurrences in client-deployment dir ==="
rg -n "explicit-deployment-for-new-devices" "$TARGET_DIR" || trueRepository: rustdesk/doc.rustdesk.com
Length of output: 345
🏁 Script executed:
#!/bin/bash
set -euo pipefail
DIR="content/self-host/client-deployment"
echo "=== English: find section heading ==="
rg -n "Explicit deployment for new devices|new devices|Require deployment for new devices" "$DIR/_index.*.md" || true
echo "=== Show the English page around the likely section ==="
if [ -f "$DIR/_index.en.md" ]; then
# Print around any matching headings (if present)
rg -n "Explicit deployment for new devices" "$DIR/_index.en.md" -n || true
# If no exact match, show lines around "new devices" occurrences
rg -n "new devices" "$DIR/_index.en.md" | head -20 || true
# Show a chunk near the first "new devices" hit
first=$(rg -n "new devices" "$DIR/_index.en.md" | head -1 | cut -d: -f1 || true)
if [ -n "${first:-}" ]; then
start=$((first-15)); end=$((first+30))
sed -n "${start},${end}p" "$DIR/_index.en.md"
fi
fi
echo "=== Localized pages: check for equivalent headings (by keywords) ==="
for f in "$DIR"/_index.*.md; do
echo "--- $(basename "$f") ---"
rg -n "new devices|部署|设备|dispositiv|apparecch|Geräte|appareil|Dispositivi|disposit|dispositivos|dispositif" "$f" | head -20 || true
doneRepository: rustdesk/doc.rustdesk.com
Length of output: 9183
🏁 Script executed:
#!/bin/bash
set -euo pipefail
rg -n "\\/docs\\/en\\/self-host\\/client-deployment\\/\\`#explicit-deployment-for-new-devices`" content/self-host/rustdesk-server-pro/console/_index.*.mdRepository: rustdesk/doc.rustdesk.com
Length of output: 215
🏁 Script executed:
#!/bin/bash
set -euo pipefail
TARGET="/docs/en/self-host/client-deployment/#explicit-deployment-for-new-devices"
rg -nF "$TARGET" content/self-host/rustdesk-server-pro/console/_index.*.mdRepository: rustdesk/doc.rustdesk.com
Length of output: 4022
Consider locale-aware deep links for the --deploy parameter (or explicitly justify the English-only link)
All locale variants in content/self-host/rustdesk-server-pro/console/_index.*.md link --deploy to the English page /docs/en/self-host/client-deployment/#explicit-deployment-for-new-devices. Localized content/self-host/client-deployment/_index.{ja,zh-cn,zh-tw,pl,pt,ro,it,de,fr,es}.md pages exist, but the “explicit deployment” section is translated there, so the English anchor likely won’t match without adding consistent per-locale anchors/ids.
Choose whether to keep the English deep-link intentionally, or update each console locale to link to its localized client-deployment section with a matching anchor (or remove the deep-link anchor if per-locale anchors aren’t standardized).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@content/self-host/rustdesk-server-pro/console/_index.ja.md` at line 148, The
link for `--deploy` in
content/self-host/rustdesk-server-pro/console/_index.ja.md points to the English
anchor /docs/en/self-host/client-deployment/#explicit-deployment-for-new-devices
which may not exist in localized client-deployment pages; either change this
locale file to point to its localized client-deployment anchor (ensure the
localized page in content/self-host/client-deployment/_index.ja.md contains the
matching id for the “explicit deployment” section) or remove/replace the anchor
with a locale-agnostic target (e.g., link to the parent localized page without
the fragment) and apply the same change to other locales’ console _index.*.md
files so links are consistent across `--deploy` references.
Summary by CodeRabbit
--deployparameter documentation with required API token permissions and platform-specific deployment guidance for Windows, macOS, Linux, and Android