mirror of
https://github.com/containers/podman.git
synced 2025-06-04 04:56:32 +08:00
486fcd4e1e
* Refactored code and Makefile to support new docs layout * Removed some old code packaging code * Add Readme.md to document what we're doing Signed-off-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: baude <bbaude@redhat.com>
64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
% 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. If no *uri* is provided, a default
|
|
URI will be used depending on the user calling the varlink service. The default for the root user is `unix:/run/podman/io.podman`. Regular
|
|
users will have a default *uri* of `$XDG_RUNTIME_DIR/podman/io.podman`. For example, `unix:/run/user/1000/podman/io.podman`
|
|
The varlink service should generally be done with systemd. See _Configuration_ below.
|
|
|
|
|
|
## OPTIONS
|
|
|
|
**--help**, **-h**
|
|
|
|
Print usage statement
|
|
|
|
**--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 accepting all default options.
|
|
|
|
```
|
|
$ podman varlink
|
|
```
|
|
|
|
|
|
Run the podman varlink service with an alternate URI and accept the default timeout.
|
|
|
|
```
|
|
$ podman varlink unix:/tmp/io.podman
|
|
```
|
|
|
|
Run the podman varlink service manually with a 5 second timeout.
|
|
|
|
```
|
|
$ podman varlink --timeout 5000
|
|
```
|
|
|
|
## CONFIGURATION
|
|
|
|
Users of the podman varlink service should enable the _io.podman.socket_ and _io.podman.service_.
|
|
This is the preferred method for running the varlink service.
|
|
|
|
You can do this via systemctl.
|
|
|
|
```
|
|
$ systemctl enable --now io.podman.socket
|
|
```
|
|
|
|
## SEE ALSO
|
|
podman(1), systemctl(1)
|
|
|
|
## HISTORY
|
|
April 2018, Originally compiled by Brent Baude<bbaude@redhat.com>
|