Environment variables
What instamix reads from the environment. A variable wins over the config files; the command line wins over both.
For a script#
| Variable | What it does |
|---|---|
INSTAMIX_PROFILE | the profiles to activate, as -p does |
INSTAMIX_ENV | 1: run ansible from an environment built with uv, as --env does |
INSTAMIX_JSONL | 1: write events on stdout, as --jsonl does |
INSTAMIX_NO_CONFIG | 1: ignore both config files |
INSTAMIX_UV | the uv to build environments with, when it is not on PATH |
SOURCE_DATE_EPOCH | the date of the entries of an archive that generate writes |
The proxy#
| Variable | What it does |
|---|---|
INSTAMIX_PROXY | fetch collections, roles and pip packages through this proxy |
INSTAMIX_PROXY_LIST | the list to fetch through; wins over the script’s proxy_list() |
INSTAMIX_PROXY_DB | the lists database (default ~/.instamix/proxy.db) |
INSTAMIX_PROXY_CACHE | where files are cached (default ~/.cache/instamix/proxy) |
INSTAMIX_PROXY_GALAXY | the Galaxy, or Automation Hub, the proxy fetches from |
INSTAMIX_PROXY_PYPI | the simple index the proxy fetches from |
Repositories and plays#
| Variable | What it does |
|---|---|
INSTAMIX_REPOS | where imix repo add keeps the repositories it clones (default ~/.local/share/instamix/repos) |
INSTAMIX_PLAYS_PATH | directories with scripts apart from the repositories, separated by colons; wins over plays.path |
The hub#
| Variable | What it does |
|---|---|
INSTAMIX_HUB | take the hosts, and what groups and hosts set, from this hub: its URL, or the path of its database |
INSTAMIX_HUB_TEAM | the team whose inventory it is |
INSTAMIX_HOME | where the hub keeps its database (default ~/.instamix) |
DATABASE_URL | the hub’s database, when it is not that file |
INSTAMIX_RUN_TIMEOUT | seconds after which a run the hub started itself fails (default 7200) |
INSTAMIX_CLOCKWORK | clockwork’s URL; unset, the hub runs things itself |
INSTAMIX_CLOCKWORK_TOKEN, INSTAMIX_CLOCKWORK_TOKEN_FILE | what the hub bears to clockwork |
INSTAMIX_CLOCKWORK_POLL | seconds between the hub’s looks at a job (default 2) |
In the pod#
| Variable | What it does |
|---|---|
INSTAMIX_PLAY_REPOS | git URLs of the playbook repositories, separated by spaces; cloned when the pod starts |
INSTAMIX_PLAYS, INSTAMIX_SSH | your scripts and your key, mounted in by deploy/compose.yaml |
The editor#
| Variable | What it does |
|---|---|
INSTAMIX_ANSIBLE_SERVER | where the Ansible language server is, for imix lsp |
Development#
| Variable | What it does |
|---|---|
INSTAMIX_NETWORK_TESTS | 1: also run the tests that build a real environment with uv |