|
@@ -1,38 +1,67 @@
|
|
|
## Chatto Plugin Installed ✅
|
|
## Chatto Plugin Installed ✅
|
|
|
|
|
|
|
|
-Next steps. Edit your `~/.hermes/.env` OR `~/.hermes/config.yaml`
|
|
|
|
|
|
|
+During installation you were prompted for the Chatto connection details, and
|
|
|
|
|
+your answers were written to `~/.hermes/.env`. Next steps: review that
|
|
|
|
|
+configuration, restart the gateway so the bot comes online, then bring it into
|
|
|
|
|
+a room and try it out.
|
|
|
|
|
|
|
|
-Environment Variables will take precedence over config.yaml entries.
|
|
|
|
|
|
|
+**Review your `~/.hermes/.env` or `config.yaml`.** Secrets (passwords, tokens)
|
|
|
|
|
+belong in `~/.hermes/.env` only — never in `config.yaml`; non-secret settings
|
|
|
|
|
+can live in either file. Environment variables take precedence over
|
|
|
|
|
+`config.yaml` entries.
|
|
|
|
|
+
|
|
|
|
|
+1. Connection details (required)
|
|
|
|
|
+
|
|
|
|
|
+ Make sure either an existing bearer token:
|
|
|
|
|
+
|
|
|
|
|
+ ```
|
|
|
|
|
+ CHATTO_TOKEN=your-token
|
|
|
|
|
+ ```
|
|
|
|
|
+
|
|
|
|
|
+ …or login plus password is set:
|
|
|
|
|
|
|
|
-1. Required connection details
|
|
|
|
|
```
|
|
```
|
|
|
CHATTO_LOGIN=your-username
|
|
CHATTO_LOGIN=your-username
|
|
|
CHATTO_PASSWORD=your-password
|
|
CHATTO_PASSWORD=your-password
|
|
|
```
|
|
```
|
|
|
- To connect to your server, set `CHATTO_BASE_URL`. Default, when not set,
|
|
|
|
|
- is ChattoHQ (`https://chat.chatto.run`)
|
|
|
|
|
|
|
+
|
|
|
|
|
+ Without `CHATTO_BASE_URL` the plugin connects to the public ChattoHQ server
|
|
|
|
|
+ (`https://chat.chatto.run`). To use your own server:
|
|
|
|
|
+
|
|
|
```
|
|
```
|
|
|
CHATTO_BASE_URL=https://chat.example.com
|
|
CHATTO_BASE_URL=https://chat.example.com
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-2. Home Channel
|
|
|
|
|
|
|
+2. Home channel (optional)
|
|
|
|
|
|
|
|
- Set your Home Channel using the Channel ID** (optional, defaults to first room):
|
|
|
|
|
- ```bash
|
|
|
|
|
|
|
+ Where cron job output and notifications get delivered. If unset (the usual
|
|
|
|
|
+ case — the installer only asks when you enter one), the first watched room
|
|
|
|
|
+ is used:
|
|
|
|
|
+
|
|
|
|
|
+ ```
|
|
|
CHATTO_HOME_CHANNEL=ROOM_ID_HERE
|
|
CHATTO_HOME_CHANNEL=ROOM_ID_HERE
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
3. Restart the Hermes Gateway
|
|
3. Restart the Hermes Gateway
|
|
|
|
|
+
|
|
|
|
|
+ The bot comes online here — the steps below need it running:
|
|
|
|
|
+
|
|
|
```bash
|
|
```bash
|
|
|
hermes gateway restart
|
|
hermes gateway restart
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-4. Test
|
|
|
|
|
- send a message in a Chatto room mentioning your bot's username.
|
|
|
|
|
|
|
+4. Add the bot to a room
|
|
|
|
|
|
|
|
-5. Add the bot to more rooms (optional)
|
|
|
|
|
|
|
+ The bot sees only rooms its account has joined — membership lives on the
|
|
|
|
|
+ Chatto server, survives gateway restarts, and nothing is joined silently on
|
|
|
|
|
+ startup. Invite the bot account natively in Chatto, or DM it:
|
|
|
|
|
|
|
|
- Invite the bot account natively in Chatto, or DM it:
|
|
|
|
|
```
|
|
```
|
|
|
/join ROOM_ID_HERE
|
|
/join ROOM_ID_HERE
|
|
|
- ```
|
|
|
|
|
|
|
+ ```
|
|
|
|
|
+
|
|
|
|
|
+5. Test
|
|
|
|
|
+
|
|
|
|
|
+ Send any message in a room the bot has joined. By default it answers every
|
|
|
|
|
+ room message; only with `CHATTO_REQUIRE_MENTION=true` do channel-kind rooms
|
|
|
|
|
+ wait for an @mention (group rooms and DMs answer regardless).
|