Skip to content
This repository was archived by the owner on May 12, 2021. It is now read-only.

Commit 9d769bb

Browse files
Add sandbox documentation
1 parent d3e6146 commit 9d769bb

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

docs/INSTALL.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,50 @@ following command line options.
7777

7878
On Windows, please make sure to add -- before options. For example,
7979
`C:\Users\YourUser\AppData\Local\Programs\ssb-patchwork\Patchwork.exe -- --proxy-server=....`
80+
81+
## Start
82+
83+
### npm
84+
85+
```shell
86+
npm start
87+
```
88+
89+
### Yarn
90+
91+
```shell
92+
yarn start
93+
```
94+
95+
## Sandbox
96+
97+
Some Linux users may see an error like this:
98+
99+
> The SUID sandbox helper binary was found, but is not configured correctly.
100+
> Rather than run without sandboxing I'm aborting now. You need to make sure
101+
> that node_modules/electron/dist/chrome-sandbox is owned by root and has mode
102+
> 4755.
103+
104+
You have three options, pick the one that you think sucks the least:
105+
106+
1. Change your kernel settings: `sudo sysctl kernel.unprivileged_userns_clone=1`
107+
2. Follow the instructions and change the file's owner to root
108+
- `sudo chown root node_modules/electron/dist/chrome-sandbox`
109+
- `sudo chmod 4755 node_modules/electron/dist/chrome-sandbox`
110+
3. Disable the sandbox with either:
111+
- `npm start -- --no-sandbox`, or
112+
- `yarn start -- --no-sandbox`
113+
114+
See also:
115+
116+
- https://github.com/electron/electron/issues/17972
117+
- https://github.com/electron-userland/electron-builder/issues/3872
118+
119+
### AppImage
120+
121+
Note that the `chown` and `chmod` solution doesn't work with AppImages, and the
122+
`--no-sandbox` requires [extra steps][appimage-fix], so the simplest solution
123+
is to use the `sysctl` option *or* use a different release format (AUR, Brew,
124+
Deb, or Snap).
125+
126+
[appimage-fix]: https://github.com/ssbc/patchwork/issues/1217#issuecomment-559609983

0 commit comments

Comments
 (0)