File: environment.md

package info (click to toggle)
incus 6.0.4-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 23,864 kB
  • sloc: sh: 16,015; ansic: 3,121; python: 456; makefile: 321; ruby: 51; sql: 50; lisp: 6
file content (43 lines) | stat: -rw-r--r-- 2,662 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Environment variables

The Incus client and daemon respect some environment variables to adapt to
the user's environment and to turn some advanced features on and off.

## Common

Name                            | Description
:---                            | :----
`INCUS_DIR`                     | The Incus data directory
`INCUS_INSECURE_TLS`            | If set to true, allows all default Go ciphers both for client <-> server communication and server <-> image servers (server <-> server and clustering are not affected)
`PATH`                          | List of paths to look into when resolving binaries
`http_proxy`                    | Proxy server URL for HTTP
`https_proxy`                   | Proxy server URL for HTTPS
`no_proxy`                      | List of domains, IP addresses or CIDR ranges that don't require the use of a proxy

## Client environment variable

Name                            | Description
:---                            | :----
`EDITOR`                        | What text editor to use
`INCUS_CONF`                    | Path to the client configuration directory
`INCUS_GLOBAL_CONF`             | Path to the global client configuration directory
`INCUS_PROJECT`                 | Name of the project to use (overrides configured default project)
`INCUS_REMOTE`                  | Name of the remote to use (overrides configured default remote)
`VISUAL`                        | What text editor to use (if `EDITOR` isn't set)

## Server environment variable

Name                            | Description
:---                            | :----
`INCUS_AGENT_PATH`              | Path to the directory including the `incus-agent` builds
`INCUS_CLUSTER_UPDATE`          | Script to call on a cluster update
`INCUS_DEVMONITOR_DIR`          | Path to be monitored by the device monitor. This is primarily for testing
`INCUS_DOCUMENTATION`           | Path to the documentation to serve through the web server
`INCUS_EDK2_PATH`               | Path to EDK2 firmware build including `*_CODE.fd` and `*_VARS.fd`
`INCUS_EXEC_PATH`               | Full path to the Incus binary (used when forking subcommands)
`INCUS_IDMAPPED_MOUNTS_DISABLE` | Disable idmapped mounts support (useful when testing traditional UID shifting)
`INCUS_LXC_TEMPLATE_CONFIG`     | Path to the LXC template configuration directory
`INCUS_SECURITY_APPARMOR`       | If set to `false`, forces AppArmor off
`INCUS_SKIP_INSTANCE_TYPES`     | If set to `true`, skip downloading instance type definitions
`INCUS_UI`                      | Path to the web UI to serve through the web server
`INCUS_USBIDS_PATH`             | Path to the hwdata `usb.ids` file