boban
/
clusev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: use the short `clusev` host-CLI aliases in the README 

Operator-facing docs must show the short host commands, not the long
docker-compose invocation (same convention already enforced for the in-panel
help/versions/MOTD surfaces):

- Updating: `sudo ./update.sh` -> `sudo clusev update`.
- Recovery: `docker compose -f docker-compose.prod.yml exec app php artisan
  clusev:reset-admin` -> `clusev reset-admin`.

Add README.md to CommandShortcutsTest's DISPLAY_SURFACES and
UPDATE_COMMAND_SURFACES so the README is regression-guarded too.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
feat/v1-foundation
boban 2026-07-02 21:26:42 +02:00
parent f3c5fee839
commit 657e659d76
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -183,13 +183,12 @@ terminal needed; a small, scoped host service performs the restart).
## Updating ## Updating
```bash ```bash
cd clusev sudo clusev update # pulls the latest code, then rebuilds, restarts and migrates
sudo ./update.sh # pulls the latest code, then rebuilds, restarts and migrates
``` ```
`update.sh` fast-forwards the repo (it never discards local changes), re-runs the idempotent installer `sudo clusev update` fast-forwards the repo (it never discards local changes), re-runs the idempotent
non-interactively, and updates itself if the script changed. Secrets and the configured domain / installer non-interactively, and updates itself if the script changed. Secrets and the configured
e-mail are preserved. (The older two-step `git pull && sudo ./install.sh` still works.) domain / e-mail are preserved. (The older two-step `git pull && sudo ./install.sh` still works.)
--- ---
@ -202,8 +201,7 @@ new password) as a fallback.
Completely locked out (lost password and 2FA, no SMTP)? Recover from the host: Completely locked out (lost password and 2FA, no SMTP)? Recover from the host:
```bash ```bash
cd clusev clusev reset-admin
docker compose -f docker-compose.prod.yml exec app php artisan clusev:reset-admin
``` ```
This clears the second factor so you can set a new password on the next login. The bare-IP This clears the second factor so you can set a new password on the next login. The bare-IP

2
tests/Feature/CommandShortcutsTest.php
View File

@ -18,6 +18,7 @@ class CommandShortcutsTest extends TestCase
'resources/views/livewire/help/content/de/domain-tls.blade.php', 'resources/views/livewire/help/content/de/domain-tls.blade.php',
'resources/views/livewire/help/content/en/domain-tls.blade.php', 'resources/views/livewire/help/content/en/domain-tls.blade.php',
'docker/motd/00-clusev', 'docker/motd/00-clusev',
'README.md',
]; ];
/** Operator-facing files that must use the short `sudo clusev update`, never `sudo ./update.sh`. */ /** Operator-facing files that must use the short `sudo clusev update`, never `sudo ./update.sh`. */
@ -30,6 +31,7 @@ class CommandShortcutsTest extends TestCase
'lang/en/system.php', 'lang/en/system.php',
'lang/de/versions.php', 'lang/de/versions.php',
'lang/en/versions.php', 'lang/en/versions.php',
'README.md',
]; ];
public function test_no_display_surface_leaks_the_long_compose_filename(): void public function test_no_display_surface_leaks_the_long_compose_filename(): void