|
| 1 | +# TAGLINE |
| 2 | + |
| 3 | +Manage OCI/Docker registry authentication |
| 4 | + |
| 5 | +# TLDR |
| 6 | + |
| 7 | +**List** all configured OCI registry credentials |
| 8 | + |
| 9 | +```apptainer registry list``` |
| 10 | + |
| 11 | +**Login** to a Docker registry |
| 12 | + |
| 13 | +```apptainer registry login --username [user] docker://[docker.io]``` |
| 14 | + |
| 15 | +**Login** to an OCI registry with **password from stdin** |
| 16 | + |
| 17 | +```apptainer registry login --username [user] --password-stdin oras://[registry.example.com]``` |
| 18 | + |
| 19 | +**Logout** from a registry |
| 20 | + |
| 21 | +```apptainer registry logout docker://[docker.io]``` |
| 22 | + |
| 23 | +**Login** using a custom **auth file** |
| 24 | + |
| 25 | +```apptainer registry login --authfile [path/to/authfile.json] --username [user] docker://[registry.example.com]``` |
| 26 | + |
| 27 | +# SYNOPSIS |
| 28 | + |
| 29 | +**apptainer registry** [_subcommand_] [_options_] |
| 30 | + |
| 31 | +# PARAMETERS |
| 32 | + |
| 33 | +**-c, --config** _string_ |
| 34 | +> Path to the registry configuration file (default ~/.apptainer/remote.yaml) |
| 35 | +
|
| 36 | +**-h, --help** |
| 37 | +> Display help for the registry command |
| 38 | +
|
| 39 | +# DESCRIPTION |
| 40 | + |
| 41 | +**apptainer registry** manages authentication to standalone OCI/Docker registries accessed via **docker://** or **oras://** protocols. It provides subcommands for logging in, logging out, and listing configured credentials for container registries. |
| 42 | + |
| 43 | +This command handles credentials separately from Apptainer's remote endpoints, allowing direct authentication against any OCI-compatible registry such as Docker Hub, GitHub Container Registry, or private registries. |
| 44 | + |
| 45 | +# SUBCOMMANDS |
| 46 | + |
| 47 | +**apptainer registry list** |
| 48 | +> Display all configured OCI registry credentials |
| 49 | +
|
| 50 | +**apptainer registry login** |
| 51 | +> Authenticate to an OCI/Docker registry |
| 52 | +
|
| 53 | +**apptainer registry logout** |
| 54 | +> Remove authentication from an OCI/Docker registry |
| 55 | +
|
| 56 | +# CAVEATS |
| 57 | + |
| 58 | +Registry credentials are stored in the Apptainer configuration file at **~/.apptainer/remote.yaml** by default. This file should be kept secure as it contains authentication tokens. Credentials configured via **apptainer registry** are separate from those managed by **apptainer remote**, which handles Sylabs Cloud and library endpoints. |
| 59 | + |
| 60 | +# SEE ALSO |
| 61 | + |
| 62 | +[apptainer](/man/apptainer)(1), [apptainer-pull](/man/apptainer-pull)(1), [apptainer-push](/man/apptainer-push)(1), [apptainer-search](/man/apptainer-search)(1) |
0 commit comments