Skip to content

docs(README): document VHS_NO_SANDBOX #505

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Delta456
Copy link
Contributor

Fixes #504

@Delta456 Delta456 requested a review from maaslalani as a code owner July 20, 2024 06:51
@shaunco
Copy link

shaunco commented Jul 20, 2024

VHS_NO_SANDBOX is not specific to server mode and should be in a different section. Would also be helpful to clarify why/when you'd want to use this, perhaps something like:

When running vhs on Linux as root or with SUID (common for WSL-based Linux on Windows), Chromium may refuse to load due to weakened sandbox capabilities. This issue can be resolved by setting the environment variable VHS_NO_SANDBOX=true, which allows Chromium to run with a weakened sandbox. This enables vhs to function without requiring a non-root or non-SUID account.

@Delta456
Copy link
Contributor Author

Delta456 commented Jul 20, 2024

VHS_NO_SANDBOX is not specific to server mode and should be in a different section. Would also be helpful to clarify why/when you'd want to use this, perhaps something like:

When running vhs on Linux as root or with SUID (common for WSL-based Linux on Windows), Chromium may refuse to load due to weakened sandbox capabilities. This issue can be resolved by setting the environment variable VHS_NO_SANDBOX=true, which allows Chromium to run with a weakened sandbox. This enables vhs to function without requiring a non-root or non-SUID account.

How about a separate section for this? Like running on Linux as root or with SUID

@caarlos0
Copy link
Member

How about a separate section for this? Like running on Linux as root or with SUID

yeah I think that would work better 🙏🏻

@caarlos0 caarlos0 added the documentation Improvements or additions to documentation label Mar 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

VHS_NO_SANDBOX ENV option needs documented
3 participants