-
-
Notifications
You must be signed in to change notification settings - Fork 490
Exposing Whitelisted Protocols to User Settings #1401
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Customizing Link Protocols | ||
|
|
||
| The Zulip app supports opening certain link protocols directly in their associated system applications. These are known as **whitelisted protocols**. | ||
|
|
||
| ## Default Whitelisted Protocols | ||
|
|
||
| By default, the following protocols are whitelisted: | ||
|
|
||
| ``` | ||
| http https mailto tel sip | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe we can separate this using a comma? |
||
| ``` | ||
|
|
||
| Links using these protocols are opened directly by the system. | ||
|
|
||
| All other protocols are considered potentially unsafe and are therefore opened indirectly—through a local HTML file—in your default web browser. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| ## Extending the Whitelisted Protocols | ||
|
|
||
| It is possible to customize the list of whitelisted protocols by editing the `settings.json` file located at: `userdata/Zulip/config/settings.json` | ||
|
|
||
| To add or modify the list, the `whitelistedProtocols` key can be updated. For example: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| ```json | ||
| { | ||
| ... | ||
| "whitelistedProtocols": [ | ||
| "http:", | ||
| "https:", | ||
| "mailto:" | ||
| ] | ||
| ... | ||
| } | ||
| ``` | ||
|
|
||
| Note: Each protocol should include the trailing colon (:), e.g., "mailto:" instead of "mailto". | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
protocolLaunchers doesn't seem like a noun. I don't think this comment is needed, since it is clear from using
ConfigUtil.getConfigItem(that we are fetching from settings.json