Skip to content

Add note about requiring sandbox #144

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 2 commits into from
Jun 17, 2025
Merged

Add note about requiring sandbox #144

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8437c8
add note about requiring sandbox
Kilian Jun 2, 2025
823844e
clarify
samuelmaddock Jun 17, 2025
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
6 changes: 4 additions & 2 deletions packages/electron-chrome-extensions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,11 @@ app.whenReady().then(() => {

const browserWindow = new BrowserWindow({
webPreferences: {
// Same session given to Extensions class
// Use same session given to Extensions class
session: browserSession,
// Recommended options for loading remote content
// Required for extension preload scripts
sandbox: true,
// Recommended for loading remote content
contextIsolation: true,
},
})
Expand Down Expand Up @@ -491,6 +492,7 @@ See [Electron's Notification tutorial](https://www.electronjs.org/docs/tutorial/
- Usage of Electron's `webRequest` API will prevent `chrome.webRequest` listeners from being called.
- Chrome extensions are not supported in non-persistent/incognito sessions.
- `chrome.webNavigation.onDOMContentLoaded` is only emitted for the top frame until [support for iframes](https://github.com/electron/electron/issues/27344) is added.
- Service worker preload scripts require Electron's sandbox to be enabled. This is the default behavior, but might be overridden by the `--no-sandbox` flag or `sandbox: false` in the `webPreferences` of a `BrowserWindow`. Check for the `--no-sandbox` flag using `ps -eaf | grep <appname>`.

## License

Expand Down