luxick/luxtools-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
luxick
2026-01-07 07:29:23 +01:00
parent 5763545f10
commit 997b165890
1 changed files with 25 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -45,37 +45,43 @@ Examples:
## Install as a service ## Install as a service
The scripts below install (or update) the client as a service that starts automatically with the system. Use the built-in `install` / `uninstall` commands to install (or update) the client as a per-user service that starts automatically.
They assume the client binary already exists in the same folder as the scripts. The `install` command copies the currently-running binary into the appropriate per-user install location.
### Linux (systemd) ### Linux (systemd)
Install / update: Install / update:
```bash ```bash
./install-linux.sh ./luxtools-client install
``` ```
Optional flags: Optional flags:
```bash ```bash
# Change listen address (still must be loopback) # Change listen address (still must be loopback)
./install-linux.sh --listen 127.0.0.1:9000 ./luxtools-client install -listen 127.0.0.1:9000
# Restrict allowed folders (repeatable) # Restrict allowed folders (repeatable)
./install-linux.sh --allow "$HOME" --allow "/mnt/data" ./luxtools-client install -allow "$HOME" -allow "/mnt/data"
# Validate only (no files written, no service changes)
./luxtools-client install -dry-run
``` ```
Uninstall: Uninstall:
```bash ```bash
./uninstall-linux.sh ./luxtools-client uninstall
``` ```
Keep config on uninstall: Keep config on uninstall:
```bash ```bash
./uninstall-linux.sh --keep-config ./luxtools-client uninstall -keep-config
# Validate only (no files removed, no service changes)
./luxtools-client uninstall -dry-run
``` ```
Notes: Notes:
@@ -91,35 +97,41 @@ Because this tool needs to open File Explorer (a GUI app) in the *current user s
Install / update: Install / update:
```bat ```bat
install-windows-task.bat luxtools-client.exe install
``` ```
Optional flags: Optional flags:
```bat ```bat
install-windows-task.bat --listen 127.0.0.1:9000 luxtools-client.exe install -listen 127.0.0.1:9000
REM Restrict allowed folders (repeatable) REM Restrict allowed folders (repeatable)
install-windows-task.bat --allow "%USERPROFILE%" --allow "D:\Data" luxtools-client.exe install -allow "%USERPROFILE%" -allow "D:\Data"
REM Validate only (no files written, no task changes)
luxtools-client.exe install -dry-run
``` ```
Uninstall: Uninstall:
```bat ```bat
uninstall-windows-task.bat luxtools-client.exe uninstall
``` ```
Keep config on uninstall: Keep config on uninstall:
```bat ```bat
uninstall-windows-task.bat --keep-config luxtools-client.exe uninstall -keep-config
REM Validate only (no files removed, no task changes)
luxtools-client.exe uninstall -dry-run
``` ```
Notes: Notes:
- Installs to `%LOCALAPPDATA%\luxtools-client\luxtools-client.exe` - Installs to `%LOCALAPPDATA%\luxtools-client\luxtools-client.exe`
- Stores config in `%LOCALAPPDATA%\luxtools-client\config.json` - Stores config in `%LOCALAPPDATA%\luxtools-client\config.json`
- Re-running the install script updates the EXE in place and restarts the task. - Re-running `install` updates the EXE in place and refreshes the task.
## API ## API