github.com/containers/podman/v5@v5.1.0-rc1/docs/source/markdown/podman-remote.1.md (about) 1 % podman-remote 1 2 3 ## NAME 4 podman-remote - A remote CLI for Podman: A Simple management tool for pods, containers and images. 5 6 ## SYNOPSIS 7 **podman-remote** [*options*] *command* 8 9 ## DESCRIPTION 10 Podman (Pod Manager) is a fully featured container engine that is a simple daemonless tool. 11 Podman provides a Docker-CLI comparable command line that eases the transition from other 12 container engines and allows the management of pods, containers and images. Simply put: `alias docker=podman`. 13 Most Podman commands can be run as a regular user, without requiring additional 14 privileges. 15 16 Podman uses Buildah(1) internally to create container images. Both tools share image 17 (not container) storage, hence each can use or manipulate images (but not containers) 18 created by the other. 19 20 Podman-remote provides a local client interacting with a Podman backend node through a RESTful API tunneled through a ssh connection. In this context, a Podman node is a Linux system with Podman installed on it and the API service activated. Credentials for this session can be passed in using flags, environment variables, or in `containers.conf`. 21 22 The `containers.conf` file is placed under `$HOME/.config/containers/containers.conf` on Linux and Mac and `%APPDATA%\containers\containers.conf` on Windows. 23 24 **podman [GLOBAL OPTIONS]** 25 26 ## GLOBAL OPTIONS 27 28 #### **--connection**=*name*, **-c** 29 30 Remote connection name 31 32 Overrides environment variable `CONTAINER_CONNECTION` if set. 33 34 #### **--help**, **-h** 35 36 Print usage statement 37 38 #### **--identity**=*path* 39 40 Path to ssh identity file. If the identity file has been encrypted, Podman prompts the user for the passphrase. 41 If no identity file is provided and no user is given, Podman defaults to the user running the podman command. 42 Podman prompts for the login password on the remote server. 43 44 Identity value resolution precedence: 45 - command line value 46 - environment variable `CONTAINER_SSHKEY`, if `CONTAINER_HOST` is found 47 - `containers.conf` 48 49 #### **--log-level**=*level* 50 51 Log messages above specified level: debug, info, warn, error (default), fatal or panic 52 53 #### **--url**=*value* 54 55 URL to access Podman service (default from `containers.conf`, rootless "unix:///run/user/$UID/podman/podman.sock" or as root "unix:///run/podman/podman.sock). 56 57 - `CONTAINER_HOST` is of the format `<schema>://[<user[:<password>]@]<host>[:<port>][<path>]` 58 - `CONTAINER_PROXY` is of the format `<socks5|socks5h>://[<user[:<password>]@]<host>[:<port>]` 59 60 Details: 61 - `schema` is one of: 62 * `ssh` (default): a local unix(7) socket on the named `host` and `port`, reachable via SSH 63 * `tcp`: an unencrypted, unauthenticated TCP connection to the named `host` and `port`, can work with proxy if `CONTAINER_PROXY` is set 64 * `unix`: a local unix(7) socket at the specified `path`, or the default for the user 65 - `user` defaults to either `root` or the current running user (`ssh` only) 66 - `password` has no default (`ssh` only) 67 - `host` must be provided and is either the IP or name of the machine hosting the Podman service (`ssh` and `tcp`) 68 - `port` defaults to 22 (`ssh` and `tcp`) 69 - `path` defaults to either `/run/podman/podman.sock`, or `/run/user/$UID/podman/podman.sock` if running rootless (`unix`), or must be explicitly specified (`ssh`) 70 - `CONTAINER_PROXY`: use proxy (`socks5` or `socks5h`) to access Podman service (`tcp` only) 71 72 URL value resolution precedence: 73 - command line value 74 - environment variable `CONTAINER_HOST` 75 - `engine.service_destinations` table in containers.conf, excluding the /usr/share/containers directory 76 - `unix:///run/podman/podman.sock` 77 78 Remote connections use local containers.conf for default. 79 80 Some example URL values in valid formats: 81 - unix:///run/podman/podman.sock 82 - unix:///run/user/$UID/podman/podman.sock 83 - ssh://notroot@localhost:22/run/user/$UID/podman/podman.sock 84 - ssh://root@localhost:22/run/podman/podman.sock 85 - tcp://localhost:34451 86 - tcp://127.0.0.1:34451 87 88 #### **--version** 89 90 Print the version 91 92 ## Environment Variables 93 94 Podman can set up environment variables from env of [engine] table in containers.conf. These variables can be overridden by passing environment variables before the `podman` commands. 95 96 #### **CONTAINERS_CONF** 97 98 Set default locations of containers.conf file 99 100 #### **CONTAINER_CONNECTION** 101 102 Set default `--connection` value to access Podman service. 103 104 #### **CONTAINER_HOST** 105 106 Set default `--url` value to access Podman service. 107 108 #### **CONTAINER_SSHKEY** 109 110 Set default `--identity` path to ssh key file value used to access Podman service. 111 112 ## Exit Status 113 114 The exit code from `podman` gives information about why the container 115 failed to run or why it exited. When `podman` commands exit with a non-zero code, 116 the exit codes follow the `chroot` standard, see below: 117 118 **125** The error is with podman itself 119 120 $ podman run --foo busybox; echo $? 121 Error: unknown flag: --foo 122 125 123 124 **126** Executing a _contained command_ and the _command_ cannot be invoked 125 126 $ podman run busybox /etc; echo $? 127 Error: container_linux.go:346: starting container process caused "exec: \"/etc\": permission denied": OCI runtime error 128 126 129 130 **127** Executing a _contained command_ and the _command_ cannot be found 131 $ podman run busybox foo; echo $? 132 Error: container_linux.go:346: starting container process caused "exec: \"foo\": executable file not found in $PATH": OCI runtime error 133 127 134 135 **Exit code** _contained command_ exit code 136 137 $ podman run busybox /bin/sh -c 'exit 3'; echo $? 138 3 139 140 141 ## COMMANDS 142 143 | Command | Description | 144 | ------------------------------------------------ | --------------------------------------------------------------------------- | 145 | [podman-attach(1)](podman-attach.1.md) | Attach to a running container. | 146 | [podman-build(1)](podman-build.1.md) | Build a container image using a Dockerfile. | 147 | [podman-commit(1)](podman-commit.1.md) | Create new image based on the changed container. | 148 | [podman-container(1)](podman-container.1.md) | Manage containers. | 149 | [podman-cp(1)](podman-cp.1.md) | Copy files/folders between a container and the local filesystem. | 150 | [podman-create(1)](podman-create.1.md) | Create a new container. | 151 | [podman-diff(1)](podman-diff.1.md) | Inspect changes on a container or image's filesystem. | 152 | [podman-events(1)](podman-events.1.md) | Monitor Podman events | 153 | [podman-export(1)](podman-export.1.md) | Export a container's filesystem contents as a tar archive. | 154 | [podman-generate(1)](podman-generate.1.md) | Generate structured data based on containers and pods. | 155 | [podman-healthcheck(1)](podman-healthcheck.1.md) | Manage healthchecks for containers | 156 | [podman-history(1)](podman-history.1.md) | Show the history of an image. | 157 | [podman-image(1)](podman-image.1.md) | Manage images. | 158 | [podman-images(1)](podman-images.1.md) | List images in local storage. | 159 | [podman-import(1)](podman-import.1.md) | Import a tarball and save it as a filesystem image. | 160 | [podman-info(1)](podman-info.1.md) | Display Podman related system information. | 161 | [podman-init(1)](podman-init.1.md) | Initialize a container | 162 | [podman-inspect(1)](podman-inspect.1.md) | Display a container or image's configuration. | 163 | [podman-kill(1)](podman-kill.1.md) | Kill the main process in one or more containers. | 164 | [podman-load(1)](podman-load.1.md) | Load an image from a container image archive into container storage. | 165 | [podman-logs(1)](podman-logs.1.md) | Display the logs of a container. | 166 | [podman-pause(1)](podman-pause.1.md) | Pause one or more containers. | 167 | [podman-pod(1)](podman-pod.1.md) | Management tool for groups of containers, called pods. | 168 | [podman-port(1)](podman-port.1.md) | List port mappings for a container. | 169 | [podman-ps(1)](podman-ps.1.md) | Print out information about containers. | 170 | [podman-pull(1)](podman-pull.1.md) | Pull an image from a registry. | 171 | [podman-push(1)](podman-push.1.md) | Push an image from local storage to elsewhere. | 172 | [podman-restart(1)](podman-restart.1.md) | Restart one or more containers. | 173 | [podman-rm(1)](podman-rm.1.md) | Remove one or more containers. | 174 | [podman-rmi(1)](podman-rmi.1.md) | Remove one or more locally stored images. | 175 | [podman-run(1)](podman-run.1.md) | Run a command in a new container. | 176 | [podman-save(1)](podman-save.1.md) | Save an image to a container archive. | 177 | [podman-start(1)](podman-start.1.md) | Start one or more containers. | 178 | [podman-stop(1)](podman-stop.1.md) | Stop one or more running containers. | 179 | [podman-system(1)](podman-system.1.md) | Manage podman. | 180 | [podman-tag(1)](podman-tag.1.md) | Add an additional name to a local image. | 181 | [podman-top(1)](podman-top.1.md) | Display the running processes of a container. | 182 | [podman-unpause(1)](podman-unpause.1.md) | Unpause one or more containers. | 183 | [podman-version(1)](podman-version.1.md) | Display the Podman version information. | 184 | [podman-volume(1)](podman-volume.1.md) | Manage Volumes. | 185 ## FILES 186 187 **containers.conf** (`$HOME/.config/containers/containers.conf`) 188 189 Podman has builtin defaults for command line options. These defaults can be overridden using the containers.conf configuration files. 190 191 Users can modify defaults by creating the `$HOME/.config/containers/containers.conf` file. Podman merges its builtin defaults with the specified fields from this file, if it exists. Fields specified in the users file override the built-in defaults. 192 193 Podman uses builtin defaults if no containers.conf file is found. 194 195 ## SEE ALSO 196 **[podman(1)](podman.1.md)**, **[podman-system-service(1)](podman-system-service.1.md)**, **[containers.conf(5)](https://github.com/containers/common/blob/main/docs/containers.conf.5.md)**