|
@@ -2,8 +2,9 @@
|
|
|
|
|
|
|
|
During installation you were prompted for the Chatto connection details, and
|
|
During installation you were prompted for the Chatto connection details, and
|
|
|
your answers were written to `~/.hermes/.env`. Next steps: review that
|
|
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.
|
|
|
|
|
|
|
+configuration — including who the bot is allowed to answer, which is off by
|
|
|
|
|
+default — restart the gateway so it comes online, then bring it into a room
|
|
|
|
|
+and try it out.
|
|
|
|
|
|
|
|
**Review your `~/.hermes/.env` or `config.yaml`.** Secrets (passwords, tokens)
|
|
**Review your `~/.hermes/.env` or `config.yaml`.** Secrets (passwords, tokens)
|
|
|
belong in `~/.hermes/.env` only — never in `config.yaml`; non-secret settings
|
|
belong in `~/.hermes/.env` only — never in `config.yaml`; non-secret settings
|
|
@@ -32,7 +33,7 @@ can live in either file. Environment variables take precedence over
|
|
|
Where cron job output and notifications get delivered when there is no
|
|
Where cron job output and notifications get delivered when there is no
|
|
|
conversation context to reply into — the default outbound target, nothing
|
|
conversation context to reply into — the default outbound target, nothing
|
|
|
more. It follows the same participation rules as any room: a silent room
|
|
more. It follows the same participation rules as any room: a silent room
|
|
|
- stays quiet, so list it in one of the mention room lists (see step 5) too
|
|
|
|
|
|
|
+ stays quiet, so list it in one of the mention room lists (see step 6) too
|
|
|
if the bot should also converse in it. If unset, context-less deliveries
|
|
if the bot should also converse in it. If unset, context-less deliveries
|
|
|
have no Chatto target and are not sent — set one if you plan to use
|
|
have no Chatto target and are not sent — set one if you plan to use
|
|
|
Hermes' proactive output:
|
|
Hermes' proactive output:
|
|
@@ -41,15 +42,31 @@ can live in either file. Environment variables take precedence over
|
|
|
CHATTO_HOME_CHANNEL=ROOM_ID_HERE
|
|
CHATTO_HOME_CHANNEL=ROOM_ID_HERE
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-3. Restart the Hermes Gateway
|
|
|
|
|
|
|
+3. Who the bot answers (required unless you open it up)
|
|
|
|
|
|
|
|
- The bot comes online here — the steps below need it running:
|
|
|
|
|
|
|
+ The bot replies only to the Chatto users you name here. If the installer
|
|
|
|
|
+ left this empty, it answers nobody — not even you. Put your own login in:
|
|
|
|
|
+
|
|
|
|
|
+ ```
|
|
|
|
|
+ CHATTO_ALLOWED_USERS=your-chatto-login,another-login
|
|
|
|
|
+ ```
|
|
|
|
|
+
|
|
|
|
|
+ Logins are matched exactly and case-sensitively. To open the bot to every
|
|
|
|
|
+ user on the server instead, use `CHATTO_ALLOW_ALL_USERS=true` — which hands
|
|
|
|
|
+ all of them the agent's capabilities, including tool use, so keep that for
|
|
|
|
|
+ a trusted, private server. Setting both is rejected as conflicting.
|
|
|
|
|
+
|
|
|
|
|
+4. Restart the Hermes Gateway
|
|
|
|
|
+
|
|
|
|
|
+ The bot comes online here, and it picks up everything above from `.env`
|
|
|
|
|
+ right now — a change made after this restart counts only from the next
|
|
|
|
|
+ one. The steps below need it running:
|
|
|
|
|
|
|
|
```bash
|
|
```bash
|
|
|
hermes gateway restart
|
|
hermes gateway restart
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-4. Add the bot to a room
|
|
|
|
|
|
|
+5. Add the bot to a room
|
|
|
|
|
|
|
|
The bot sees only rooms its account has joined — membership lives on the
|
|
The bot sees only rooms its account has joined — membership lives on the
|
|
|
Chatto server, survives gateway restarts, and nothing is joined silently on
|
|
Chatto server, survives gateway restarts, and nothing is joined silently on
|
|
@@ -59,10 +76,11 @@ can live in either file. Environment variables take precedence over
|
|
|
/join ROOM_ID_HERE
|
|
/join ROOM_ID_HERE
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-5. Test
|
|
|
|
|
|
|
+6. Test
|
|
|
|
|
|
|
|
- Send any message in a room the bot has joined. DMs answer right away;
|
|
|
|
|
- every other room stays silent until you list it — in
|
|
|
|
|
|
|
+ Send any message in a room the bot has joined — as one of the users from
|
|
|
|
|
+ step 3, since everyone else is ignored. DMs answer right away; every other
|
|
|
|
|
+ room stays silent until you list it — in
|
|
|
`CHATTO_REQUIRE_MENTION_ROOMS` (answers only when the message addresses
|
|
`CHATTO_REQUIRE_MENTION_ROOMS` (answers only when the message addresses
|
|
|
the bot via `@name`, `@all` or `@here`) or `CHATTO_OPTIONAL_MENTION_ROOMS`
|
|
the bot via `@name`, `@all` or `@here`) or `CHATTO_OPTIONAL_MENTION_ROOMS`
|
|
|
(answers every message). The `/join` reply prints both lines ready to
|
|
(answers every message). The `/join` reply prints both lines ready to
|