38 lines
1.4 KiB
Markdown
38 lines
1.4 KiB
Markdown
# Usage Guide for Autoscale Bot
|
||
|
||
## Command Prefixes
|
||
The bot listens for the following prefixes:
|
||
- `!hs`
|
||
- `!headscale`
|
||
|
||
## User Commands
|
||
| Command | Description |
|
||
| ------- | ----------- |
|
||
| `!hs create <username>` | Create a Headscale user |
|
||
| `!hs discord <username>` | Link your Discord account to a Headscale user |
|
||
| `!hs link <nodekey>` | Register a device |
|
||
| `!hs register` | Get the Tailscale registration command |
|
||
| `!hs list` | List all nodes and their IPs |
|
||
| `!hs rename <id> <new_name>` | Rename your node |
|
||
| `!hs info` | Show bot information |
|
||
| `!hs ticket panel` | Post the ticket panel (admin only) |
|
||
| `!hs ticket close` | Close a ticket (admin/support only) |
|
||
| `!hs restart` | Restart the bot (admin only) |
|
||
| `!hs update` | Check for a new version and update the bot |
|
||
|
||
## Admin Commands
|
||
- `!hs addadmin @user` – Grant admin privileges (owner only)
|
||
- `!hs removeadmin @user` – Revoke admin privileges (owner only)
|
||
- `!hs listadmins` – List all admin users
|
||
- `!hs deleteuser <username>` – Delete a Headscale user
|
||
- `!hs removenode <id>` – Force‑remove a node
|
||
- `!hs preauth <username>` – Generate a pre‑auth key
|
||
|
||
## Auto‑Updater
|
||
The `!hs update` command triggers the auto‑updater. If a newer release is found on GitHub, the bot will:
|
||
1. Pull the latest code.
|
||
2. Install any new dependencies.
|
||
3. Restart itself.
|
||
|
||
Make sure the bot has write permissions to its directory.
|