9b0c8d23bd
Command flags (OPTIONS) in man pages have to date been in haphazard order. Sometimes that order is sensible, e.g., most-important options first, but more often they're just in arbitrary places. This makes life hard for users. Here, I update the man-page-check Makefile script so it checks and enforces alphabetical order in OPTIONS sections. Then -- the hard part -- update all existing man pages to conform to this requirement. Signed-off-by: Ed Santiago <santiago@redhat.com>
2.3 KiB
% 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)
To access the API service inside a container:
- mount the socket as a volume
- run the container with
--security-opt label=disable
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.
Note: The default systemd unit files (system and user) change the log-level option to info from error. This change provides additional information on each API call.
OPTIONS
--cors
CORS headers to inject to the HTTP response. The default value is empty string which disables CORS headers.
--help, -h
Print usage statement.
--time, -t
The time until the session expires in seconds. The default is 5
seconds. A value of 0 means no timeout, therefore the session will not expire.
The default timeout can be changed via the service_timeout=VALUE field in containers.conf.
See containers.conf(5) for more information.
EXAMPLES
Run an API listening for 5 seconds using the default socket.
podman system service --time 5
SEE ALSO
podman(1), podman-system-connection(1), containers.conf(5)
HISTORY
January 2020, Originally compiled by Brent Baude <bbaude@redhat.com>
November 2020, Updated by Jhon Honce (jhonce at redhat dot com)