Skip to content

Open-source AI teammates in Slack, Teams, Discord, Telegram and Mattermost. Self-host it, with any agent harness and any model.

[CHOO-3403] Correct what the avatar services see in the THIRD_PARTY_AVATARS_ENABLED docs (#1069)

Christian McDermott16ee40b38e03
diff --git a/.env.example b/.env.example
index 092810849..550641ef1 100644
--- a/.env.example
+++ b/.env.example
@@ -136,9 +136,12 @@ TELEMETRY_ENVIRONMENT=local
# ── Avatars ──────────────────────────────────────────────────────────────────
# An agent with no icon of its own is drawn by api.dicebear.com with its name as
# the seed, and a person relayed from another platform by ui-avatars.com with
-# their name in the URL. Chat clients load those images, so the services see
-# the name and each reader's address. Set false to send no such URL: each
-# platform shows its own default icon instead.
+# their name in the URL, so the services see the name. Slack and Discord fetch
+# the image on their own servers and serve their copy, Teams draws it inside
+# each card (some Teams clients may load it from the service directly), the
+# Mattermost bridge fetches it from this server, and Switch Console loads it on
+# each user's machine. Set false to send no such URL: each platform shows its
+# own default icon instead (a Mattermost bot keeps the image it already has).
# THIRD_PARTY_AVATARS_ENABLED=true
# ── Client identity ──────────────────────────────────────────────────────────
diff --git a/core/switch_core/config.py b/core/switch_core/config.py
index 69dd9c02e..6e3283f63 100644
--- a/core/switch_core/config.py
+++ b/core/switch_core/config.py
@@ -524,13 +524,16 @@ class SwitchConfig(BaseSettings):
# Whether agents and people may be drawn by outside avatar services. An
# agent with no icon of its own wears a face from api.dicebear.com seeded
# with its name, and a person relayed from another platform a lettered
- # badge from ui-avatars.com with their name in the URL. Slack, Discord and
- # Teams clients load those URLs, so the services see the name and each
- # reader's address; the Mattermost adapter loads them from this server.
+ # badge from ui-avatars.com with their name in the URL, so the services
+ # see the name. Slack and Discord fetch the image on their own servers and
+ # serve their copy, Teams draws it inside each card (some Teams clients may
+ # load it from the service directly), the Mattermost adapter fetches it
+ # from this server, and Switch Console loads it on each user's machine.
# False sends no such URL anywhere, stored ones included: each platform
- # shows its own default icon, new agents get no generated icon, setting an
- # icon on one of those services is refused, and Switch Console stops
- # drawing them for this server's agents.
+ # shows its own default icon (a Mattermost bot keeps the image it already
+ # has), new agents get no generated icon, setting an icon on one of those
+ # services is refused, and Switch Console stops drawing them for this
+ # server's agents.
third_party_avatars_enabled: bool = True
server_host: str = "0.0.0.0"
diff --git a/deploy/remote/helm/switch/README.md b/deploy/remote/helm/switch/README.md
index 2d01a43c6..a8cdebafe 100644
--- a/deploy/remote/helm/switch/README.md
+++ b/deploy/remote/helm/switch/README.md
@@ -200,9 +200,11 @@ stored in the database.
An agent with no icon of its own is drawn by api.dicebear.com with its name as
the seed, and a person relayed from another platform by ui-avatars.com with their
-name in the URL. Slack, Discord and Teams clients load those images, so the
-services see the name and each reader's address; the Mattermost bridge loads them
-from switch-core. To send no such URL:
+name in the URL, so the services see the name. Slack and Discord fetch the image
+on their own servers and serve their copy, Teams draws it inside each card (some
+Teams clients may load it from the service directly), the Mattermost bridge
+fetches it from switch-core, and Switch Console loads it on each user's machine.
+To send no such URL:
```yaml
switchCore:
@@ -211,11 +213,11 @@ switchCore:
```
Each platform then shows its own default icon (Slack the app's icon, Discord its
-default avatar, Teams no image), icons already stored on those services are
-withheld too, and new agents get no generated icon. Setting an icon on one of
-those services is refused with the reason. Switch Console asks the server and
-stops drawing them for its agents. An icon an owner set on any other host is
-unaffected.
+default avatar, Teams no image; a Mattermost bot keeps the image it already has),
+icons already stored on those services are withheld too, and new agents get no
+generated icon. Setting an icon on one of those services is refused with the
+reason. Switch Console asks the server and stops drawing them for its agents. An
+icon an owner set on any other host is unaffected.
## Follow the conversation
diff --git a/deploy/remote/helm/switch/values.yaml b/deploy/remote/helm/switch/values.yaml
index feb681555..51ea65516 100644
--- a/deploy/remote/helm/switch/values.yaml
+++ b/deploy/remote/helm/switch/values.yaml
@@ -308,10 +308,14 @@ switchCore:
# Agents and people drawn by outside avatar services. An agent with no icon
# of its own wears a face from api.dicebear.com seeded with its name, and a
# person relayed from another platform a lettered badge from ui-avatars.com
- # with their name in the URL. Chat clients load those images, so the services
- # see the name and each reader's address. false sends no such URL, stored
- # icons included: each platform shows its own default icon, new agents get no
- # generated icon, and Switch Console stops drawing them for this server.
+ # with their name in the URL, so the services see the name. Slack and Discord
+ # fetch the image on their own servers, Teams draws it inside each card (some
+ # Teams clients may load it from the service directly), the Mattermost bridge
+ # fetches it from switch-core, and Switch Console loads it on each user's
+ # machine. false sends no such URL, stored icons included: each platform
+ # shows its own default icon (a Mattermost bot keeps the image it already
+ # has), new agents get no generated icon, and Switch Console stops drawing
+ # them for this server.
thirdPartyAvatars:
enabled: true