.\" Generated by scdoc 1.11.5
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "SYD\-OCI" "1" "2026\-09\-01"
.PP
.SH NAME
.PP
\fBsyd\-oci\fR \- OCI container runtime
.PP
.SH SYNOPSIS
.PP
\fBsyd\-oci\fR \fI[OPTIONS]\fR \fI[COMMAND]\fR
.PP
.SH DESCRIPTION
.PP
syd\-oci is an OCI container runtime implementation for \fIsyd\fR(1).\&
.PP
All common subcommands are supported: create, start, state, kill,
delete, pause, resume, exec, run, list, ps, spec, events, features,
update.\& Checkpoint/restore support is planned in the near future.\& See
the respective youki issue,
https://github.\&com/youki\-dev/youki/issues/142, for more information.\&
.PP
.SH INTEGRATION
.PP
syd\-oci is a thin wrapper around \fIyouki\fR(1) that integrates the \fIsyd\fR(1)
sandbox into containers.\& It is compatible with \fIdocker\fR(1) and
\fIpodman\fR(1).\& To get syd\-oci, you should build \fIsyd\fR(1) with the \fBoci\fR
feature.\& To use syd\-oci with \fIdocker\fR(1) you have two options: Either
start \fIdockerd\fR(8) manually with the option
\fB\-\-add\-runtime=syd\-oci=/bin/syd\-oci\fR, and do for example
\fBdocker run \-it \-\-runtime=syd\-oci alpine\fR when starting containers,
or add the following snippet to your \fB/etc/docker/daemon.\&json\fR file:
.PP
.nf
.RS 4
{
"runtimes": { "syd\-oci": { "path": "/bin/syd\-oci" } },
"default\-runtime": "syd\-oci"
}
.fi
.RE
.PP
You may need to adapt the path to syd\-oci depending on your
installation.\&  To use with \fIpodman\fR(1) is similar, just pass
\fB\-\-runtime=/bin/syd\-oci\fR as an option to \fBpodman run\fR.\&
.PP
.SH CONFIGURATION
.PP
The configuration directory of syd\-oci is one of the following:
.PP
.PD 0
.IP \(bu 4
For system\-wide containers: \fB/etc/syd/oci\fR
.IP \(bu 4
For rootless containers, one of the following:
  \- \fB${XDG_CONFIG_HOME}/syd/oci\fR where XDG_CONFIG_HOME is usually \fB\(ti/.\&config\fR.\&
  \- \fB${HOME}/.\&syd/oci\fR if XDG_CONFIG_HOME is not set.\&
.PD
.PP
syd\-oci attempts to configure the \fIsyd\fR(1) sandbox in the following order,
and parses the first file or profile it locates and stops processing, the
environment variable \fBSYD_OCI_NO_CONFIG\fR may be set to skip to the final step:
.PP
.PD 0
.IP \(bu 4
If hostname and domainname is defined for the container, try to load
\fB${SYD_CONFIG_DIR}/${hostname}.\&${domainname}.\&syd\-3\fR.\&
.IP \(bu 4
If domainname is defined for the container, try to load
\fB${SYD_CONFIG_DIR}/${domainname}.\&syd\-3\fR.\&
.IP \(bu 4
If hostname is defined for the container, try to load
\fB${SYD_CONFIG_DIR}/${hostname}.\&syd\-3\fR.\&
.IP \(bu 4
Try to load \fB${SYD_CONFIG_DIR}/default.\&syd\-3\fR
.IP \(bu 4
Load the builtin \fBoci\fR profile.\&
This profile is designed to be combined with \fIpandora\fR(1) and learning mode.\&
See \fBsyd\-cat \-p oci\fR for the list of rules.\&
.PD
.PP
SYD_CONFIG_DIR in the items above refer to the configuration directory.\&
Refer to \fIsyd\fR(5) for the syntax of \fIsyd\fR(1) configuration files and
\fIsyd\fR(2) for a list of configuration items \fIsyd\fR(1) understands.\& A
\fIvim\fR(1) syntax highlighting file is also provided to easily edit
\fIsyd\fR(1) configuration files.\& Use \fBsyd\-cat file.\&syd\-3\fR to check a
\fIsyd\fR(1) configuration file for syntax errors.\&
.PP
Located configuration is recorded verbatim at create in
\fBorg.\&exherbo.\&syd.\&config\fR annotation of the container, from which the
sandbox is initialized thereafter, so exec processes share the sandbox
rules of the init process.\&
.PP
Finally, note that \fBinclude\fR directives are not supported in syd\-oci
configuration files.\& This is to ensure main process and exec processes
share the same sandbox rules.\&
.PP
.SH SEE ALSO
.PP
\fIsyd\fR(1), \fIsyd\fR(2), \fIsyd\fR(5), \fIsyd\fR(7), \fIpandora\fR(1), \fIdocker\fR(1),
\fIdockerd\fR(8), \fIpodman\fR(1), \fIyouki\fR(1)
.PP
.PD 0
.IP \(bu 4
\fBsyd\fR homepage: https://sydbox.\&exherbo.\&org/
.IP \(bu 4
\fByouki\fR homepage: https://containers.\&github.\&io/youki/
.PD
.PP
.SH AUTHORS
.PP
Maintained by Ali Polatel.\& Up\-to\-date sources can be found at
https://gitlab.\&exherbo.\&org/sydbox/sydbox.\&git and on Radicle at
rad:z38HCnbmcDegA2BMxuPaPRPMdp6wF.\& Bugs/patches can be submitted to
https://gitlab.\&exherbo.\&org/groups/sydbox/\-/issues.\& Discuss in #sydbox on Libera
Chat or in #sydbox:mailstation.\&de on Matrix.\&