aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-service.1.md
blob: 5c55e20d37986d9dccf8bd52153495e7eea46710 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
% podman-service(1)

## NAME
podman\-service - Run an API service

## SYNOPSIS
**podman service** [*options*]

## DESCRIPTION
The **podman 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*)

## OPTIONS

**--timeout**, **-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.

**--varlink**

Use the varlink protocol instead of the REST-based protocol.  This option will be deprecated in the future.

**--help**, **-h**

Print usage statement.

## EXAMPLES

Run an API listening for 5 seconds using the default socket.
```
podman service --timeout 5000
```

Run the podman varlink service with an alternate URI and accept the default timeout.
```
$ podman service --varlink unix:/tmp/io.podman
```

## SEE ALSO
podman(1), podman-varlink(1)

## HISTORY
January 2020, Originally compiled by Brent Baude<bbaude@redhat.com>