Add install scripts
This commit is contained in:
75
README.md
75
README.md
@@ -49,6 +49,81 @@ Examples:
|
||||
./luxtools-client -allow "$HOME"
|
||||
```
|
||||
|
||||
## Install as a service
|
||||
|
||||
The scripts below install (or update) the client as a service that starts automatically with the system.
|
||||
They assume the client binary already exists in the same folder as the scripts.
|
||||
During install/update, the scripts prompt you for the shared token (press Enter to keep the current token, if already configured).
|
||||
|
||||
### Linux (systemd)
|
||||
|
||||
Install / update:
|
||||
|
||||
```bash
|
||||
./install-linux.sh
|
||||
```
|
||||
|
||||
Optional flags:
|
||||
|
||||
```bash
|
||||
# Change listen address (still must be loopback)
|
||||
./install-linux.sh --listen 127.0.0.1:9000
|
||||
|
||||
# Restrict allowed folders (repeatable)
|
||||
./install-linux.sh --allow "$HOME" --allow "/mnt/data"
|
||||
```
|
||||
|
||||
Uninstall:
|
||||
|
||||
```bash
|
||||
./uninstall-linux.sh
|
||||
```
|
||||
|
||||
Keep token/config on uninstall:
|
||||
|
||||
```bash
|
||||
./uninstall-linux.sh --keep-config
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- Installs to `/opt/luxtools-client/luxtools-client`
|
||||
- Creates `/etc/systemd/system/luxtools-client.service`
|
||||
- Stores config (including the generated token) in `/etc/luxtools-client/luxtools-client.env`
|
||||
|
||||
### Windows (Service)
|
||||
|
||||
Run from an elevated (Administrator) Command Prompt.
|
||||
|
||||
Install / update:
|
||||
|
||||
```bat
|
||||
install-windows.bat
|
||||
```
|
||||
|
||||
Optional flags:
|
||||
|
||||
```bat
|
||||
install-windows.bat --listen 127.0.0.1:9000
|
||||
```
|
||||
|
||||
Uninstall:
|
||||
|
||||
```bat
|
||||
uninstall-windows.bat
|
||||
```
|
||||
|
||||
Keep token/config on uninstall:
|
||||
|
||||
```bat
|
||||
uninstall-windows.bat --keep-config
|
||||
```
|
||||
|
||||
Notes:
|
||||
|
||||
- Installs to `%ProgramFiles%\LuxtoolsClient\luxtools-client.exe`
|
||||
- Stores the generated token in `%ProgramData%\LuxtoolsClient\token.txt`
|
||||
|
||||
## API
|
||||
|
||||
### Auth
|
||||
|
||||
Reference in New Issue
Block a user