Skip to content

docs(cli): document SKIP_VERSION_CHECK and IDLE_TIMEOUT_MS in --help #758

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

Open
richardmilles wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

docs(cli): document SKIP_VERSION_CHECK and IDLE_TIMEOUT_MS in --help #758

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions bin/pi-web-options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ Environment:
PI_WEB_NO_OPEN Set to 1/true/yes/on to disable browser open
PI_WEB_PASSWORD Enable HTTP Basic Auth (username is always "pi")
PI_WEB_ALLOWED_HOSTS Extra exact proxy/custom hostnames, comma-separated
PI_WEB_SKIP_VERSION_CHECK Set to 1 to disable Pi Web update checks
PI_WEB_IDLE_TIMEOUT_MS Session idle timeout in ms (0 disables; default 600000)
`;
}

Expand Down
2 changes: 2 additions & 0 deletions lib/pi-web-options.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ test("supports --help and -h without starting the server", () => {
assert.match(getHelpText(), /--port/);
assert.match(getHelpText(), /--hostname/);
assert.match(getHelpText(), /--no-open/);
assert.match(getHelpText(), /PI_WEB_SKIP_VERSION_CHECK/);
assert.match(getHelpText(), /PI_WEB_IDLE_TIMEOUT_MS/);
});

test("rejects unknown options with a help hint", () => {
Expand Down
Loading