github.com/containers/podman/v2@v2.2.2-0.20210501105131-c1e07d070c4c/docs/source/markdown/podman-system-service.1.md (about)

     1  % podman-service(1)
     2  
     3  ## NAME
     4  podman\-system\-service - Run an API service
     5  
     6  ## SYNOPSIS
     7  **podman system service** [*options*]
     8  
     9  ## DESCRIPTION
    10  The **podman system service** command creates a listening service that will answer API calls for Podman.  You may
    11  optionally provide an endpoint for the API in URI form.  For example, *unix://tmp/foobar.sock* or *tcp:localhost:8080*.
    12  If no endpoint is provided, defaults will be used.  The default endpoint for a rootfull
    13  service is *unix:/run/podman/podman.sock* and rootless is *unix:/$XDG_RUNTIME_DIR/podman/podman.sock* (for
    14  example *unix:/run/user/1000/podman/podman.sock*)
    15  
    16  The REST API provided by **podman system service** is split into two parts: a compatibility layer offering support for the Docker v1.40 API, and a Podman-native Libpod layer.
    17  Documentation for the latter is available at *https://docs.podman.io/en/latest/_static/api.html*.
    18  Both APIs are versioned, but the server will not reject requests with an unsupported version set.
    19  
    20  Note: The default systemd unit files (system and user) change the log-level option to *info* from *error*. This change provides additional information on each API call.
    21  
    22  ## OPTIONS
    23  
    24  #### **--time**, **-t**
    25  
    26  The time until the session expires in _seconds_. The default is 5
    27  seconds. A value of `0` means no timeout, therefore the session will not expire.
    28  
    29  #### **--help**, **-h**
    30  
    31  Print usage statement.
    32  
    33  ## EXAMPLES
    34  
    35  Run an API listening for 5 seconds using the default socket.
    36  ```
    37  podman system service --timeout 5000
    38  ```
    39  
    40  ## SEE ALSO
    41  podman(1), podman-system-service(1), podman-system-connection(1)
    42  
    43  ## HISTORY
    44  January 2020, Originally compiled by Brent Baude<bbaude@redhat.com>
    45  November 2020, Updated by Jhon Honce <jhonce at redhat.com>