Skip to content

Commit 9061493

Browse files
authored
docs: document location property for support links (coder#20445)
1 parent 6187acf commit 9061493

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

docs/admin/setup/appearance.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,18 @@ server.
5757

5858
The link icons are optional, and can be set to any url or
5959
[builtin icon](../templates/extending-templates/icons.md#bundled-icons),
60-
additionally `bug`, `chat`, and `docs` are available as three special icons.
60+
additionally `bug`, `chat`, `docs`, and `star` are available as special icons.
61+
62+
### Location
63+
64+
The `location` property is optional and determines where the support link will
65+
be displayed:
66+
67+
- `navbar` - displays the link as a button in the top navigation bar
68+
- `dropdown` - displays the link in the user dropdown menu (default)
69+
70+
If the `location` property is not specified, the link will be displayed in the
71+
user dropdown menu.
6172

6273
### Configuration
6374

@@ -77,7 +88,7 @@ coder:
7788
"https://codercom.slack.com/archives/C014JH42DBJ", "icon":
7889
"/icon/slack.svg"},
7990
{"name": "Hello Discord", "target": "https://discord.gg/coder", "icon":
80-
"/icon/discord.svg"},
91+
"/icon/discord.svg", "location": "navbar"},
8192
{"name": "Hello Foobar", "target": "https://foo.com/bar", "icon":
8293
"/emojis/1f3e1.png"}]
8394
```
@@ -88,12 +99,12 @@ if running as a system service, set an environment variable
8899
`CODER_SUPPORT_LINKS` in `/etc/coder.d/coder.env` as follows,
89100

90101
```env
91-
CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw-hub.myxuebi.top/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw-hub.myxuebi.top/coder/coder/main/site/static/icon/discord.svg"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
102+
CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw-hub.myxuebi.top/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw-hub.myxuebi.top/coder/coder/main/site/static/icon/discord.svg", "location": "navbar"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
92103
```
93104

94105
For CLI, use,
95106

96107
```shell
97-
export CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw-hub.myxuebi.top/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw-hub.myxuebi.top/coder/coder/main/site/static/icon/discord.svg"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
108+
export CODER_SUPPORT_LINKS='[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"}, {"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "https://raw-hub.myxuebi.top/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw-hub.myxuebi.top/coder/coder/main/site/static/icon/discord.svg", "location": "navbar"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
98109
coder-server
99110
```

0 commit comments

Comments
 (0)