1podman-service(1)() podman-service(1)()
2
3
4
6 podman-system-service - Run an API service
7
8
10 podman system service [options]
11
12
14 The podman system service command creates a listening service that will
15 answer API calls for Podman. You may optionally provide an endpoint
16 for the API in URI form. For example, unix:///tmp/foobar.sock or
17 tcp:localhost:8080. If no endpoint is provided, defaults will be used.
18 The default endpoint for a rootful service is unix:///run/podman/pod‐
19 man.sock and rootless is unix://$XDG_RUNTIME_DIR/podman/podman.sock
20 (for example unix:///run/user/1000/podman/podman.sock)
21
22
23 To access the API service inside a container: - mount the socket as a
24 volume - run the container with --security-opt label=disable
25
26
27 The REST API provided by podman system service is split into two parts:
28 a compatibility layer offering support for the Docker v1.40 API, and a
29 Podman-native Libpod layer. Documentation for the latter is available
30 at https://docs.podman.io/en/latest/_static/api.html. Both APIs are
31 versioned, but the server will not reject requests with an unsupported
32 version set.
33
34
35 Note: The default systemd unit files (system and user) change the log-
36 level option to info from error. This change provides additional infor‐
37 mation on each API call.
38
39
41 --cors
42 CORS headers to inject to the HTTP response. The default value is empty
43 string which disables CORS headers.
44
45
46 --help, -h
47 Print usage statement.
48
49
50 --time, -t
51 The time until the session expires in seconds. The default is 5 sec‐
52 onds. A value of 0 means no timeout, therefore the session will not ex‐
53 pire.
54
55
56 The default timeout can be changed via the service_timeout=VALUE field
57 in containers.conf. See containers.conf(5) for more information.
58
59
61 Run an API listening for 5 seconds using the default socket.
62
63
64 podman system service --time 5
65
66
67
69 podman(1), podman-system-connection(1), containers.conf(5)
70
71
73 January 2020, Originally compiled by Brent Baude <bbaude@redhat.com>
74 November 2020, Updated by Jhon Honce (jhonce at redhat dot com)
75
76
77
78 podman-service(1)()