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

Commit

Permalink
man: Add ostree-container-auth
Browse files Browse the repository at this point in the history
Add a man page (which we'll figure out how to install later)
describing the state of things.
  • Loading branch information
cgwalters committed Sep 19, 2023
1 parent 8dc1f95 commit 3842d1e
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions man/ostree-container-auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
% ostree-container-auth 5

# NAME
ostree-container-auth description of the registry authentication file

# DESCRIPTION

The OSTree container stack uses the same file formats as **containers-auth(5)** but
not the same locations.

When running as uid 0 (root), the tooling uses `/etc/ostree/auth.json` first, then looks
in `/run/ostree/auth.json`. For any other uid, the file paths used are in `${XDG_RUNTIME_DIR}/ostree/auth.json`.

In the future, it is likely that a path that is supported for both "system podman"
usage and ostree will be added.

## FORMAT

The auth.json file stores, or references, credentials that allow the user to authenticate
to container image registries.
It is primarily managed by a `login` command from a container tool such as `podman login`,
`buildah login`, or `skopeo login`.

For more information, see **containers-auth(5)**.

# SEE ALSO

**containers-auth(5)**, **skopeo-login(1)**, **skopeo-logout(1)**

0 comments on commit 3842d1e

Please sign in to comment.