summaryrefslogtreecommitdiff
path: root/docs/podman-varlink.1.md
blob: d53457e224d6f68232f23f4b63d9699bc3fa8ef9 (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
48
49
50
51
52
53
% podman-varlink "1"

## NAME
podman\-varlink - Runs the varlink backend interface

## SYNOPSIS
**podman varlink** [*options*] *uri*

## DESCRIPTION
Starts the varlink service listening on *uri* that allows varlink clients to interact with podman.  This should generally be done
with systemd.  See _Configuration_ below.

## GLOBAL OPTIONS

**--help, -h**
  Print usage statement

## OPTIONS
**--timeout, -t**

The time until the varlink session expires in _milliseconds_. The default is 1
second. A value of `0` means no timeout and the session will not expire.

## EXAMPLES

Run the podman varlink service manually and accept the default timeout.

```
# podman varlink unix:/run/podman/io.projectatomic.podman
```

Run the podman varlink service manually with a 5 second timeout.

```
# podman varlink --timeout 5000 unix:/run/podman/io.projectatomic.podman
```

## CONFIGURATION

Users of the podman varlink service should enable the _io.projectatomic.podman.socket_ and _io.projectatomic.podman.service_.
This is the preferred method for running the varlink service.

You can do this via systemctl.

```
# systemctl enable --now io.projectatomic.podman.socket
```

## SEE ALSO
podman(1), systemctl(1)

## HISTORY
April 2018, Originally compiled by Brent Baude<bbaude@redhat.com>