Files
podman/docs/source/markdown/podman-service.1.md
baude d4c2aaf38a Add service endpoint
add service endpoint for the new API.  Also supports the varlink
implementation.

Signed-off-by: baude <bbaude@redhat.com>

Refactor to allow developer more control of API server

* Add api.NewServerWithSettings() to create an API server with custom
  settings
* Add api.ListenUnix() to create a UDS net.Listener and setup UDS

Signed-off-by: Jhon Honce <jhonce@redhat.com>
Signed-off-by: baude <bbaude@redhat.com>

More service completion

Add podman service command that allows users to run either a RESTful or
varlink protocol API service.

Addition of docs and RESTful listening.

Signed-off-by: baude <bbaude@redhat.com>
Signed-off-by: Brent Baude <bbaude@redhat.com>
2020-01-21 16:35:45 -06:00

1.3 KiB

% 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 Baudebbaude@redhat.com