Environment variables
This page lists the environment variables the Outpost agent reads on an endpoint, for agent 0.2.0. The agent takes its settings from its configuration file, which the installer writes, and from policy in the console. These variables are the exceptions, for settings that must work before or outside that file.
- Component: the Outpost agent, on every platform it supports.
- The service behind your console is run by Outpost and has no variables for you to set.
- The list covers the variables meant for production endpoints in agent 0.2.0. Variables that exist for development and testing are left out.
The variables
Section titled “The variables”| Variable | Default | What it does |
|---|---|---|
OUTPOST_SERVER_URL | None. The server URL in the configuration file is used. | The server URL for enroll and run. A --server flag takes precedence over it, and it takes precedence over the configuration file. |
OUTPOST_LOG_LEVEL | info | How much the agent logs: debug, info, warn, or error. Any other value means info. Read when the agent starts. |
OUTPOST_DATA_DIR | C:\ProgramData\Outpost on Windows, /etc/outpost on every other platform | Moves the agent’s data directory, which holds its configuration, certificate and private key, and logs. The agent, the watchdog, and the tray all follow it. |
HTTPS_PROXY | None. The proxy in the configuration file is used, if any. | An HTTP proxy for the agent’s outbound connections. Takes precedence over the proxy in the configuration file. The lowercase https_proxy works too. |
NO_PROXY | None | Hosts the agent connects to directly rather than through HTTPS_PROXY, as a comma-separated list. The lowercase no_proxy works too. |
Notes on individual variables
Section titled “Notes on individual variables”OUTPOST_LOG_LEVEL
Section titled “OUTPOST_LOG_LEVEL”Use debug for one run while you investigate a problem, then set it back.
On Windows, the log files are capped at 8 MB each before they roll over, so a
long debug run keeps only the most recent detail. See
Where the logs are.
OUTPOST_DATA_DIR
Section titled “OUTPOST_DATA_DIR”The data directory holds the agent’s identity. An agent started with a different data directory does not find its configuration or certificate there. Set it only when you need the agent’s files somewhere else, and set it the same way for every program that runs from the install.
On Windows, run, install, uninstall, and reset do not ask for
elevation when OUTPOST_DATA_DIR is set. Start them from an elevated prompt
yourself.
HTTPS_PROXY
Section titled “HTTPS_PROXY”The proxy you enter when you download an installer is stored in the configuration file. The agent applies it only when no proxy variable is set, so a variable set on one computer overrides the installer’s proxy there. See Proxies.
Where to set them
Section titled “Where to set them”On Linux, the outpost-agent systemd service reads
/etc/default/outpost-agent when it starts. The file is optional. Add one
variable per line and restart the service:
OUTPOST_LOG_LEVEL=debugHTTPS_PROXY=http://proxy.example.com:8080sudo systemctl restart outpost-agentFor a command you run by hand, such as outpost-agent enroll, set the
variable in that shell before you run it.
Related
Section titled “Related”Content is licensed CC BY 4.0. Code samples are MIT. Outpost and the Outpost mark are trademarks of Outpost Business Solutions, PBC and are not covered by either license.