Skip to content

Commit c3b1169

Browse files
authored
docs: update docs to set SupportLinks
1 parent 1f63a11 commit c3b1169

File tree

1 file changed

+24
-46
lines changed

1 file changed

+24
-46
lines changed

docs/admin/appearance.md

Lines changed: 24 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -48,65 +48,43 @@ server.
4848

4949
![support links](../images/admin/support-links.png)
5050

51-
Custom links can be set in the deployment configuration using the
52-
`-c <yamlFile>` flag to `coder server`.
53-
54-
```yaml
55-
supportLinks:
56-
- name: "On-call 🔥"
57-
target: "http://on-call.example.internal"
58-
icon: "bug"
59-
- name: "😉 Getting started with Go!"
60-
target: "https://go.dev/"
61-
- name: "Community"
62-
target: "https://github.com/coder/coder"
63-
icon: "chat"
64-
```
65-
6651
### Icons
6752

68-
The link icons are optional, and limited to: `bug`, `chat`, and `docs`.
53+
The link icons are optional, and can be set to any url or bultin icon, additionally `bug`, `chat`, and `docs` are availble as three special icons.
6954

70-
### Kubernetes configuration
55+
### Configuration
7156

72-
To pass in the `supportLinks` YAML file above into your Coder Kubernetes
73-
deployment, follow the steps below.
57+
<div class=tab>
58+
59+
#### Kubernetes
7460

75-
#### 1. Create Kubernetes Secret From File
76-
77-
Run the below command to create the YAML file as a Kubernetes secret in your
78-
cluster:
79-
80-
```console
81-
kubectl create secret generic coder-support-links -n <coder-namespace> --from-file=config.yaml
82-
```
83-
84-
#### 2. Mount Secret as Volume in Helm Chart
85-
86-
Next, update your Helm chart values as follows:
61+
To configure support links in your Coder Kubernetes
62+
deployment, update your Helm chart values as follows:
8763

8864
```yaml
8965
coder:
9066
env:
91-
- name: CODER_CONFIG_PATH
92-
value: /etc/coder/config.yaml
93-
volumes:
94-
- name: coder-config
95-
secret:
96-
secretName: coder-support-links
97-
volumeMounts:
98-
- name: coder-config
99-
mountPath: /etc/coder/
67+
- name: CODER_SUPPORT_LINKS
68+
value: >
69+
[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"},
70+
{"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "/icon/slack.svg"},
71+
{"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "/icon/discord.svg"},
72+
{"name": "Hello Foobar", "target": "https://foo.com/bar", "icon": "/emojis/1f3e1.png"}]
10073
```
10174
102-
#### 3. Upgrade Coder
103-
104-
Lastly, upgrade Coder using the following command:
105-
106-
```console
107-
helm upgrade coder coder-v2/coder -n <coder-namespace> -f <values-file.yaml>
75+
#### System package
76+
if running as a sytem servive, set an envrionment variable `CODER_SUPPORT_LINKS` in `/etc/coder.d/coder.env` as follows,
77+
```env
78+
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.githubusercontent.com/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/discord.svg"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
79+
```
80+
For CLI, use.
81+
```shell
82+
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.githubusercontent.com/coder/coder/main/site/static/icon/slack.svg"}, {"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/discord.svg"}, {"name": "Hello Foobar", "target": "https://discord.gg/coder", "icon": "/emojis/1f3e1.png"}]'
83+
coder-server
10884
```
10985

86+
</div>
87+
11088
## Up next
11189

11290
- [Enterprise](../enterprise.md)

0 commit comments

Comments
 (0)