Exactly one of `keyPath` and `keyData` must be present, containing a sigstore public key. Only signatures made by this key is accepted.
Exactly one of `keyPath`, `keyData` and `fulcio` must be present.
If `keyPath` or `keyData` is present, it contains a sigstore public key.
Only signatures made by this key are accepted.
If `fulcio` is present, the signature must be based on a Fulcio-issued certificate.
One of `caPath` and `caData` must be specified, containing the public key of the Fulcio instance.
Both `oidcIssuer` and `subjectEmail` are mandatory,
exactly specifying the expected identity provider,
and the identity of the user obtaining the Fulcio certificate.
At most one of `rekorPublicKeyPath` and `rekorPublicKeyData` can be present;
it is mandatory if `fulcio` is specified.
If a Rekor public key is specified,
the signature must have been uploaded to a Rekor server
and the signature must contain an (offline-verifiable) “signed entry timestamp”
proving the existence of the Rekor log record,
signed by the provided public key.
The `signedIdentity` field has the same semantics as in the `signedBy` requirement described above.
The `signedIdentity` field has the same semantics as in the `signedBy` requirement described above.
Note that `cosign`-created signatures only contain a repository, so only `matchRepository` and `exactRepository` can be used to accept them (and that does not protect against substitution of a signed image with an unexpected tag).
Note that `cosign`-created signatures only contain a repository, so only `matchRepository` and `exactRepository` can be used to accept them (and that does not protect against substitution of a signed image with an unexpected tag).
@ -286,6 +313,21 @@ selectively allow individual transports and scopes as desired.
"keyPath": "/path/to/sigstore-pubkey.pub"
"keyPath": "/path/to/sigstore-pubkey.pub"
}
}
],
],
/* A sigstore-signed repository using the community Fulcio+Rekor servers.
The community servers’ public keys can be obtained from
@ -27,45 +27,42 @@ No bare options are used. The format of TOML can be simplified to:
The `storage` table supports the following options:
The `storage` table supports the following options:
**driver**=""
**driver**=""
container storage driver
Copy On Write (COW) container storage driver. Valid drivers are "overlay", "vfs", "devmapper", "aufs", "btrfs", and "zfs". Some drivers (for example, "zfs", "btrfs", and "aufs") may not work if your kernel lacks support for the filesystem.
Default Copy On Write (COW) container storage driver. Valid drivers are "overlay", "vfs", "devmapper", "aufs", "btrfs", and "zfs". Some drivers (for example, "zfs", "btrfs", and "aufs") may not work if your kernel lacks support for the filesystem.
This field is required to guarantee proper operation.
This field is required to guarantee proper operation.
Valid rootless drivers are "btrfs", "overlay", and "vfs".
Valid rootless drivers are "btrfs", "overlay", and "vfs".
Rootless users default to the driver defined in the system configuration when possible.
Rootless users default to the driver defined in the system configuration when possible.
When the system configuration uses an unsupported rootless driver, rootless users default to "overlay" if available, otherwise "vfs".
When the system configuration uses an unsupported rootless driver, rootless users default to "overlay" if available, otherwise "vfs".
**graphroot**=""
**graphroot**=""
container storage graph dir (default: "/var/lib/containers/storage")
container storage graph dir (default: "/var/lib/containers/storage")
Default directory to store all writable content created by container storage programs.
Default directory to store all writable content created by container storage programs.
The rootless graphroot path supports environment variable substitutions (ie. `$HOME/containers/storage`)
The rootless graphroot path supports environment variable substitutions (ie. `$HOME/containers/storage`).
When changing the graphroot location on an SELINUX system, ensure
When changing the graphroot location on an SELINUX system, ensure the labeling matches the default locations labels with the following commands:
the labeling matches the default locations labels with the
following commands:
```
```
# semanage fcontext -a -e /var/lib/containers/storage /NEWSTORAGEPATH
# semanage fcontext -a -e /var/lib/containers/storage /NEWSTORAGEPATH
# restorecon -R -v /NEWSTORAGEPATH
# restorecon -R -v /NEWSTORAGEPATH
```
```
In Rootless Mode you would set
In rootless mode you would set
```
```
# semanage fcontext -a -e $HOME/.local/share/containers NEWSTORAGEPATH
# semanage fcontext -a -e $HOME/.local/share/containers NEWSTORAGEPATH
Storage path for rootless users. By default the graphroot for rootless users
Storage path for rootless users. By default the graphroot for rootless users is set to `$XDG_DATA_HOME/containers/storage`, if XDG_DATA_HOME is set. Otherwise `$HOME/.local/share/containers/storage` is used. This field can be used if administrators need to change the storage location for all users. The rootless storage path supports environment variable substitutions (ie. `$HOME/containers/storage`)
is set to `$XDG_DATA_HOME/containers/storage`, if XDG_DATA_HOME is set.
Otherwise `$HOME/.local/share/containers/storage` is used. This field can
be used if administrators need to change the storage location for all users.
The rootless storage path supports environment variable substitutions (ie. `$HOME/containers/storage`)
A common use case for this field is to provide a local storage directory when user home directories are NFS-mounted (podman does not support container storage over NFS).
A common use case for this field is to provide a local storage directory when user home directories are NFS-mounted (podman does not support container storage over NFS).
**runroot**=""
**runroot**=""
container storage run dir (default: "/run/containers/storage")
container storage run dir (default: "/run/containers/storage")
Default directory to store all temporary writable content created by container storage programs.
Default directory to store all temporary writable content created by container storage programs. The rootless runroot path supports environment variable substitutions (ie. `$HOME/containers/storage`)
The rootless runroot path supports environment variable substitutions (ie. `$HOME/containers/storage`)
**driver_priority**=[]
Priority list for the storage drivers that will be tested one after the other to pick the storage driver if it is not defined. The first storage driver in this list that can be used, will be picked as the new one and all subsequent ones will not be tried. If all drivers in this list are not viable, then **all** known drivers will be tried and the first working one will be picked.
By default, the storage driver is set via the `driver` option. If it is not defined, then the best driver will be picked according to the current platform. This option allows you to override this internal priority list with a custom one to prefer certain drivers.
Setting this option only has an effect if the local storage has not been initialized yet and the driver name is not set.
### STORAGE OPTIONS TABLE
### STORAGE OPTIONS TABLE
@ -216,20 +213,19 @@ The `storage.options.overlay` table supports the following options:
**force_mask** = "0000|shared|private"
**force_mask** = "0000|shared|private"
ForceMask specifies the permissions mask that is used for new files and
ForceMask specifies the permissions mask that is used for new files and
directories.
directories. The values "shared" and "private" are accepted. (default: ""). Octal permission
The values "shared" and "private" are accepted. (default: ""). Octal permission
masks are also accepted.
masks are also accepted.
``: Not set
- ``: Not set
All files/directories, get set with the permissions identified within the
All files/directories, get set with the permissions identified within the
image.
image.
`private`: it is equivalent to 0700.
-`private`: it is equivalent to 0700.
All files/directories get set with 0700 permissions. The owner has rwx
All files/directories get set with 0700 permissions. The owner has rwx
access to the files. No other users on the system can access the files.
access to the files. No other users on the system can access the files.
This setting could be used with networked based home directories.
This setting could be used with networked based home directories.
`shared`: it is equivalent to 0755.
-`shared`: it is equivalent to 0755.
The owner has rwx access to the files and everyone else can read, access
The owner has rwx access to the files and everyone else can read, access
and execute them. This setting is useful for sharing containers storage
and execute them. This setting is useful for sharing containers storage
with other users. For instance, a storage owned by root could be shared
with other users. For instance, a storage owned by root could be shared
@ -244,7 +240,7 @@ Note: The force_mask Flag is an experimental feature, it could change in the
future. When "force_mask" is set the original permission mask is stored in the
future. When "force_mask" is set the original permission mask is stored in the
"user.containers.override_stat" xattr and the "mount_program" option must be
"user.containers.override_stat" xattr and the "mount_program" option must be
specified. Mount programs like "/usr/bin/fuse-overlayfs" present the extended
specified. Mount programs like "/usr/bin/fuse-overlayfs" present the extended
attribute permissions to processes within containers rather then the
attribute permissions to processes within containers rather than the
"force_mask" permissions.
"force_mask" permissions.
**mount_program**=""
**mount_program**=""
@ -340,7 +336,7 @@ This is a way to prevent xfs_quota management from conflicting with containers/s
Distributions often provide a `/usr/share/containers/storage.conf` file to define default storage configuration. Administrators can override this file by creating `/etc/containers/storage.conf` to specify their own configuration. Likewise rootless users can create a storage.conf file to override the system storage.conf files. Files should be stored in the `$XDG_CONFIG_HOME/containers/storage.conf` file. If `$XDG_CONFIG_HOME` is not set then the file `$HOME/.config/containers/storage.conf` is used.
Distributions often provide a `/usr/share/containers/storage.conf` file to define default storage configuration. Administrators can override this file by creating `/etc/containers/storage.conf` to specify their own configuration. Likewise rootless users can create a storage.conf file to override the system storage.conf files. Files should be stored in the `$XDG_CONFIG_HOME/containers/storage.conf` file. If `$XDG_CONFIG_HOME` is not set then the file `$HOME/.config/containers/storage.conf` is used.
Note: The storage.conf file overrides all other strorage.conf files. Container
Note: The storage.conf file overrides all other storage.conf files. Container
engines run by users with a storage.conf file in their home directory do not
engines run by users with a storage.conf file in their home directory do not
@ -11,6 +11,11 @@ containers-transports - description of supported transports for copying and stor
Tools which use the containers/image library, including skopeo(1), buildah(1), podman(1), all share a common syntax for referring to container images in various locations.
Tools which use the containers/image library, including skopeo(1), buildah(1), podman(1), all share a common syntax for referring to container images in various locations.
The general form of the syntax is _transport:details_, where details are dependent on the specified transport, which are documented below.
The general form of the syntax is _transport:details_, where details are dependent on the specified transport, which are documented below.
The semantics of the image names ultimately depend on the environment where
they are evaluated. For example: if evaluated on a remote server, image names
might refer to paths on that server; relative paths are relative to the current
@ -88,22 +88,24 @@ List of default capabilities for containers.
The default list is:
The default list is:
```
```
default_capabilities = [
default_capabilities = [
"AUDIT_WRITE",
"CHOWN",
"CHOWN",
"DAC_OVERRIDE",
"DAC_OVERRIDE",
"FOWNER",
"FOWNER",
"FSETID",
"FSETID",
"KILL",
"KILL",
"MKNOD",
"NET_BIND_SERVICE",
"NET_BIND_SERVICE",
"NET_RAW",
"SETFCAP",
"SETGID",
"SETGID",
"SETPCAP",
"SETPCAP",
"SETUID",
"SETUID",
"SYS_CHROOT",
]
]
```
```
Note, by default container engines using containers.conf, run with less
capabilities than Docker. Docker runs additionally with "AUDIT_WRITE", "MKNOD",
"NET_RAW", "CHROOT". If you need to add one of these capabilities for a
particular container, you can use the --cap-add option or edit your system's containers.conf.
**default_sysctls**=[]
**default_sysctls**=[]
A list of sysctls to be set in containers by default,
A list of sysctls to be set in containers by default,
@ -197,9 +199,9 @@ the container.
Indicates whether the container engine uses MAC(SELinux) container separation via labeling. This option is ignored on disabled systems.
Indicates whether the container engine uses MAC(SELinux) container separation via labeling. This option is ignored on disabled systems.
**log_driver**="k8s-file"
**log_driver**=""
Logging driver for the container. Available options: `k8s-file` and `journald`.
Logging driver for the container. Currently available options are k8s-file, journald, none and passthrough, with json-file aliased to k8s-file for scripting compatibility. The journald driver is used by default if the systemd journal is readable and writable. Otherwise, the k8s-file driver is used.
**log_size_max**=-1
**log_size_max**=-1
@ -241,6 +243,10 @@ is imposed.
Copy the content from the underlying image into the newly created volume when the container is created instead of when it is started. If `false`, the container engine will not copy the content until the container is started. Setting it to `true` may have negative performance implications.
Copy the content from the underlying image into the newly created volume when the container is created instead of when it is started. If `false`, the container engine will not copy the content until the container is started. Setting it to `true` may have negative performance implications.
**read_only**=true|false
Run all containers with root file system mounted read-only. Set to false by default.
The list of the OCI runtimes that support `--format=json`.
The list of the OCI runtimes that support `--format=json`.
@ -684,6 +690,10 @@ used as the backend for Podman named volumes. Individual plugins are specified
below, as a map of the plugin name (what the plugin will be called) to its path
below, as a map of the plugin name (what the plugin will be called) to its path
(filepath of the plugin's unix socket).
(filepath of the plugin's unix socket).
**[engine.platform_to_oci_runtime]**
Allows end users to switch the OCI runtime on the bases of container image's platform string.
Following config field contains a map of `platform/string = oci_runtime`.
## SECRET TABLE
## SECRET TABLE
The `secret` table contains settings for the configuration of the secret subsystem.
The `secret` table contains settings for the configuration of the secret subsystem.
@ -711,11 +721,13 @@ The size of the disk in GB created when init-ing a podman-machine VM
**image**=""
**image**=""
Default image used when creating a new VM using `podman machine init`.
Default image URI when creating a new VM using `podman machine init`.
Options: On Linux/Mac, `testing`, `stable`, `next`. On Windows, the major
Options: On Linux/Mac, `testing`, `stable`, `next`. On Windows, the major
version of the OS (e.g `35`). For all platforms you can alternatively specify
version of the OS (e.g `36`) for Fedora 36. For all platforms you can
a custom path or download URL to an image. The default is `testing` on
alternatively specify a custom download URL to an image. Container engines
Linux/Mac, and `35` on Windows.
translate URIs $OS and $ARCH to the native OS and ARCH. URI "https://example.com/$OS/$ARCH/foobar.ami" would become "https://example.com/linux/amd64/foobar.ami" on a Linux AMD machine.
The default value
is `testing` on Linux/Mac, and on Windows.
**memory**=2048
**memory**=2048
@ -733,6 +745,8 @@ Environment variables like $HOME as well as complete paths are supported for
the source and destination. An optional third field `:ro` can be used to
the source and destination. An optional third field `:ro` can be used to
tell the container engines to mount the volume readonly.
tell the container engines to mount the volume readonly.
On Mac, the default volumes are: `"/Users:/Users", "/private:/private", "/var/folders:/var/folders"`