Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit6090007

Browse files
authored
docs: update docs to set SupportLinks (#11699)
1 parentd67c9d1 commit6090007

File tree

2 files changed

+48
-45
lines changed

2 files changed

+48
-45
lines changed

‎docs/admin/appearance.md

Lines changed: 34 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -48,65 +48,55 @@ 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
54+
[builtin icon](../templates/icons.md#bundled-icons), additionally`bug`,`chat`,
55+
and`docs` are available as three special icons.
6956

70-
###Kubernetes configuration
57+
###Configuration
7158

72-
To pass in the `supportLinks` YAML file above into your Coder Kubernetes
73-
deployment, follow the steps below.
59+
<divclass=tab>
60+
61+
####Kubernetes
7462

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:
63+
To configure support links in your Coder Kubernetes deployment, update your Helm
64+
chart values as follows:
8765

8866
```yaml
8967
coder:
9068
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/
69+
-name:CODER_SUPPORT_LINKS
70+
value:>
71+
[{"name": "Hello GitHub", "target": "https://github.com/coder/coder",
72+
"icon": "bug"},
73+
{"name": "Hello Slack", "target":
74+
"https://codercom.slack.com/archives/C014JH42DBJ", "icon":
75+
"/icon/slack.svg"},
76+
{"name": "Hello Discord", "target": "https://discord.gg/coder", "icon":
77+
"/icon/discord.svg"},
78+
{"name": "Hello Foobar", "target": "https://foo.com/bar", "icon":
79+
"/emojis/1f3e1.png"}]
10080
```
10181
102-
#### 3. Upgrade Coder
82+
#### System package
83+
84+
if running as a system service, set an environment variable
85+
`CODER_SUPPORT_LINKS` in `/etc/coder.d/coder.env` as follows,
10386

104-
Lastly, upgrade Coder using the following command:
87+
```env
88+
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"}]'
89+
```
90+
91+
For CLI, use,
10592

106-
```console
107-
helm upgrade coder coder-v2/coder -n <coder-namespace> -f <values-file.yaml>
93+
```shell
94+
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"}]'
95+
coder-server
10896
```
10997

98+
</div>
99+
110100
## Up next
111101

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

‎docs/templates/icons.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,20 @@ come bundled with your Coder deployment.
3636

3737
-[**Authentication Providers**](https://coder.com/docs/v2/latest/admin/external-auth):
3838

39-
- Use icons for external authentication providers to make them recognizable
39+
- Use icons for external authentication providers to make them recognizable.
40+
You can set an icon for each provider by setting the
41+
`CODER_EXTERNAL_AUTH_X_ICON` environment variable, where`X` is the number
42+
of the provider.
43+
44+
```env
45+
CODER_EXTERNAL_AUTH_0_ICON=/icon/github.svg
46+
CODER_EXTERNAL_AUTH_1_ICON=/icon/google.svg
47+
```
48+
49+
- [**Support Links**](../admin/appearance#support-links):
50+
51+
- Use icons for support links to make them recognizable. You can set the
52+
`icon` field for each link in `CODER_SUPPORT_LINKS` array.
4053
4154
## Bundled icons
4255

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp