Skip to content
This repository has been archived by the owner on Jan 8, 2024. It is now read-only.

Commit

Permalink
Not being unnecessarily perscriptive about truthiness, per Rae's sugg…
Browse files Browse the repository at this point in the history
…estion
  • Loading branch information
izaaklauer committed Jun 23, 2021
1 parent 20ed08f commit c7f0a64
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
6 changes: 3 additions & 3 deletions website/content/docs/automating-execution/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ configure the Waypoint CLI for communication with the Waypoint server.
- `WAYPOINT_SERVER_TOKEN`. Must be set to a Waypoint token, created with [`waypoint token new`](/commands/token-new)
- `WAYPOINT_SERVER_ADDR`. The address to the Waypoint server gRPC address. This must
be accessible from the network that the client is running on.
- `WAYPOINT_SERVER_TLS`. Should be set to `1` to configure the client to use TLS when
- `WAYPOINT_SERVER_TLS`. Should be set to a truthy value (e.g. "1") to configure the client to use TLS when
connecting to the server.
- `WAYPOINT_SERVER_TLS_SKIP_VERIFY`. Current must be set to `1` to disable TLS verification
- `WAYPOINT_SERVER_TLS_SKIP_VERIFY`. Current must be set to truthy value (e.g. "1") to disable TLS verification
when communicating with the server.

~> The Waypoint server token is sensitive and should be
Expand All @@ -71,7 +71,7 @@ If Waypoint detects that the terminal does not support interactivity it will out
simpler "non-interactive" output mode. This output is easier to consume in
a CI/CD systems logging views, or through log archiving systems. This is automatic
and does not need to be explicitly configured, but can be forced by setting
the environment variable `WAYPOINT_PLAIN` to `1`.
the environment variable `WAYPOINT_PLAIN` to a truthy value (e.g. "1").

## Workspaces

Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/entrypoint/disable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ deployments and apps.
## Disable at Runtime

You can disable the entrypoint at runtime by setting the `WAYPOINT_CEB_DISABLE`
environment variable to 1.
environment variable to a truthy value (e.g. "1").

This environment variable is checked immediately on entrypoint startup. If
it is set to 1 then the entrypoint will immediately execute the
the value is true, then the entrypoint will immediately execute the
child process. The entrypoint **will not** attempt to even connect to the
server and will not use any network or disk resources.

Expand Down
8 changes: 5 additions & 3 deletions website/content/docs/runner/run-manual.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,11 @@ The environment variables specify how to connect to the server:
that the runner can reach. The port should be for the gRPC API, and
is typically 9701.

- `WAYPOINT_SERVER_TLS` should be set to 1 if the server is listening
on TLS. You may additionally set `WAYPOINT_SERVER_TLS_SKIP_VERIFY` to
1 if the TLS cert is invalid and can be safely ignored
- `WAYPOINT_SERVER_TLS` should be set to a truthy value (e.g. "1") if
the server is listening on TLS.

- `WAYPOINT_SERVER_TLS_SKIP_VERIFY` should be set to a truthy value
(e.g. "1") if the TLS cert is invalid and can be safely ignored,
such as in a development environment.

- `WAYPOINT_SERVER_TOKEN` should be an [auth token](/docs/server/auth)
Expand Down

0 comments on commit c7f0a64

Please sign in to comment.