mirror of
https://github.com/containers/podman.git
synced 2025-05-24 18:46:26 +08:00
a9912b52d0
This makes it clear that we target compatibility with a specific Docker version (v1.40), but do not reject other versions. It also adds a link to documentation on the Podman-specific API. Signed-off-by: Matthew Heon <mheon@redhat.com>
43 lines
1.5 KiB
Markdown
43 lines
1.5 KiB
Markdown
% podman-service(1)
|
|
|
|
## NAME
|
|
podman\-system\-service - Run an API service
|
|
|
|
## SYNOPSIS
|
|
**podman system service** [*options*]
|
|
|
|
## DESCRIPTION
|
|
The **podman system service** command creates a listening service that will answer API calls for Podman. You may
|
|
optionally provide an endpoint for the API in URI form. For example, *unix://tmp/foobar.sock* or *tcp:localhost:8080*.
|
|
If no endpoint is provided, defaults will be used. The default endpoint for a rootfull
|
|
service is *unix:/run/podman/podman.sock* and rootless is *unix:/$XDG_RUNTIME_DIR/podman/podman.sock* (for
|
|
example *unix:/run/user/1000/podman/podman.sock*)
|
|
|
|
The REST API provided by **podman system service** is split into two parts: a compatibility layer offering support for the Docker v1.40 API, and a Podman-native Libpod layer.
|
|
Documentation for the latter is available at *https://docs.podman.io/en/latest/_static/api.html*.
|
|
Both APIs are versioned, but the server will not reject requests with an unsupported version set.
|
|
|
|
## OPTIONS
|
|
|
|
**--time**, **-t**
|
|
|
|
The time until the session expires in _milliseconds_. The default is 1
|
|
second. A value of `0` means no timeout and the session will not expire.
|
|
|
|
**--help**, **-h**
|
|
|
|
Print usage statement.
|
|
|
|
## EXAMPLES
|
|
|
|
Run an API listening for 5 seconds using the default socket.
|
|
```
|
|
podman system service --timeout 5000
|
|
```
|
|
|
|
## SEE ALSO
|
|
podman(1), podman-system-service(1), podman-system-connection(1)
|
|
|
|
## HISTORY
|
|
January 2020, Originally compiled by Brent Baude<bbaude@redhat.com>
|