Skip to content

Commit e333a68

Browse files
adding documentation for link protocols
1 parent dfe3839 commit e333a68

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Customizing Link Protocols
2+
3+
The Zulip app supports opening certain link protocols directly in their associated system applications. These are known as **whitelisted protocols**.
4+
5+
## Default Whitelisted Protocols
6+
7+
By default, the following protocols are whitelisted:
8+
9+
```
10+
http https mailto tel sip
11+
```
12+
13+
Links using these protocols are opened directly by the system.
14+
15+
All other protocols are considered potentially unsafe and are therefore opened indirectly—through a local HTML file—in your default web browser.
16+
17+
## Extending the Whitelisted Protocols
18+
It is possible to customize the list of whitelisted protocols by editing the `settings.json` file located at: `userdata/Zulip/config/settings.json`
19+
20+
To add or modify the list, the `whitelistedProtocols` key can be updated. For example:
21+
22+
```json
23+
{
24+
...
25+
"whitelistedProtocols": [
26+
"http:",
27+
"https:",
28+
"mailto:"
29+
]
30+
...
31+
}
32+
```
33+
34+
Note: Each protocol should include the trailing colon (:), e.g., "mailto:" instead of "mailto".

0 commit comments

Comments
 (0)