podman-varlink(1)

1podman-varlink (1"")                                      podman-varlink (1"")
2
3
4

NAME

6       podman-varlink - Runs the varlink backend interface
7
8

SYNOPSIS

10       podman varlink [options] uri
11
12

DESCRIPTION

14       Starts the varlink service listening on uri that allows varlink clients
15       to interact with podman.  If no uri is provided, a default URI will be
16       used depending on the user calling the varlink service.  The default
17       for the root user is unix:/run/podman/io.podman. Regular users will
18       have a default uri of $XDG_RUNTIME_DIR/podman/io.podman.  For example,
19       unix:/run/user/1000/podman/io.podman The varlink service should
20       generally be done with systemd.  See Configuration below.
21
22

GLOBAL OPTIONS

24       --help, -h
25         Print usage statement
26
27

OPTIONS

29       --timeout, -t
30
31
32       The time until the varlink session expires in milliseconds. The default
33       is 1 second. A value of 0 means no timeout and the session will not
34       expire.
35
36

EXAMPLES

38       Run the podman varlink service accepting all default options.
39
40
41              $ podman varlink
42
43
44
45       Run the podman varlink service with an alternate URI and accept the
46       default timeout.
47
48
49              $ podman varlink unix:/tmp/io.podman
50
51
52
53       Run the podman varlink service manually with a 5 second timeout.
54
55
56              $ podman varlink --timeout 5000
57
58
59

CONFIGURATION

61       Users of the podman varlink service should enable the io.podman.socket
62       and io.podman.service.  This is the preferred method for running the
63       varlink service.
64
65
66       You can do this via systemctl.
67
68
69              $ systemctl enable --now io.podman.socket
70
71
72

HISTORY

78       April 2018, Originally compiled by Brent Baude ⟨bbaude@redhat.com⟩
79
80
81
82                                                          podman-varlink (1"")