Defining Internal URLs

What are Internal URLs?
Internal URLs are links that open within your desktop app window instead of an external browser window i.e. Chrome, Safari, Firefox etc.
If you want to force a page to open in the user's browser then you can use our openUrlInBrowser API.
By default, login provider URLs (also known as OAuth) and URLs on the same domain as your app are considered internal.
Here is an example of some links considered internal and external if your web app is https://www.icecream.com:
Internal URLs
External URLs
✅ https://app.icecream.com
❌ https://apple.com
✅ https://sundaes.icecream.com
❌ https://amazon.com
✅ https://accounts.google.com/oauth
​
Login providers currently supported include: Facebook, LinkedIn, Github, Twitter and Google.
Adding Internal URLs
You can add more internal URLs if needed. 
In your Edit app page, select the Internal URLs checkbox under App Options. Here you can add a regex (short for regular expression) of URLs to be considered internal.
For example, if your app is https://www.icecream.com and you want to include the domains of apple.com and amazon.com as internal, this is how the regex input would look:
1
.*(apple.com|amazon.com).*
Copied!
Configuring this correctly can be tricky so if you have any trouble please get in touch and we will help you out.
Editing Internal URLs on the Edit App page
Dynamically adding Internal URLs
Sometimes it may be neccesary to dynamically change internal URLs. You can use our runtime API to do this. To get current internal URLs you can use window.todesktop.app.getInternalUrls(). To update internal URLs you can use window.todesktop.app.updateInternalUrls(newInternalUrls).
1
await window.todesktop.app.getInternalUrls();
2
// -> ".*(apple.com|amazon.com).*"
3
​
4
// Let's add google.com as an internal URL
5
const newInternalUrls = ".*(apple.com|amazon.com|google.com).*";
6
await window.todesktop.app.updateInternalUrls(newInternalUrls);
7
​
8
await window.todesktop.app.getInternalUrls();
9
// -> ".*(apple.com|amazon.com|google.com).*"
Copied!

App Options - Previous

Launch at Startup (macOS, Windows only)

Next - App Options

App Protocols and Deeplinks

Last modified 6mo ago

Copy link

Contents

What are Internal URLs?

Adding Internal URLs

Dynamically adding Internal URLs