Skip to content

docs: update docs to set SupportLinks #11699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jan 19, 2024
Merged

docs: update docs to set SupportLinks #11699

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9015207
fixup!
matifali Jan 19, 2024
4161b6b
Update link icons and add instructions for setting icons for external…
matifali Jan 19, 2024
996cfc8
Add support for using icons in support links
matifali Jan 19, 2024
c3b1169
docs: update docs to set SupportLinks
matifali Jan 19, 2024
c69da03
Add files via upload
matifali Jan 19, 2024
c7154fc
`make fmt`
matifali Jan 19, 2024
367b509
Delete site/static/icon/github.svg
matifali Jan 19, 2024
6c56127
Discard changes to site/static/icon/github.svg
matifali Jan 19, 2024
27be04b
add link to icons
matifali Jan 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
make fmt
  • Loading branch information
@matifali
matifali committed Jan 19, 2024
commit c7154fc7d95799e80faa11938334e69ad82b9dde
33 changes: 22 additions & 11 deletions docs/admin/appearance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,34 +50,45 @@ server.

### Icons

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.
The link icons are optional, and can be set to any url or builtin icon,
additionally `bug`, `chat`, and `docs` are available as three special icons.

### Configuration

<div class=tab>

#### Kubernetes

To configure support links in your Coder Kubernetes
deployment, update your Helm chart values as follows:
To configure support links in your Coder Kubernetes deployment, update your Helm
chart values as follows:

```yaml
coder:
env:
- name: CODER_SUPPORT_LINKS
value: >
[{"name": "Hello GitHub", "target": "https://github.com/coder/coder", "icon": "bug"},
{"name": "Hello Slack", "target": "https://codercom.slack.com/archives/C014JH42DBJ", "icon": "/icon/slack.svg"},
{"name": "Hello Discord", "target": "https://discord.gg/coder", "icon": "/icon/discord.svg"},
{"name": "Hello Foobar", "target": "https://foo.com/bar", "icon": "/emojis/1f3e1.png"}]
- name: CODER_SUPPORT_LINKS
value: >
[{"name": "Hello GitHub", "target": "https://github.com/coder/coder",
"icon": "bug"},
{"name": "Hello Slack", "target":
"https://codercom.slack.com/archives/C014JH42DBJ", "icon":
"/icon/slack.svg"},
{"name": "Hello Discord", "target": "https://discord.gg/coder", "icon":
"/icon/discord.svg"},
{"name": "Hello Foobar", "target": "https://foo.com/bar", "icon":
"/emojis/1f3e1.png"}]
```

#### System package
if running as a sytem servive, set an envrionment variable `CODER_SUPPORT_LINKS` in `/etc/coder.d/coder.env` as follows,

if running as a system service, set an environment variable `CODER_SUPPORT_LINKS`
in `/etc/coder.d/coder.env` as follows,

```env
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"}]'
```
For CLI, use.

For CLI, use,

```shell
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"}]'
coder-server
Expand Down