1podman-remote(1)            General Commands Manual           podman-remote(1)
2
3
4

NAME

6       podman-remote  -  A remote CLI for Podman: A Simple management tool for
7       pods, containers and images.
8
9

SYNOPSIS

11       podman-remote [options] command
12
13

DESCRIPTION

15       Podman (Pod Manager) is a fully featured container  engine  that  is  a
16       simple  daemonless  tool.  Podman provides a Docker-CLI comparable com‐
17       mand line that eases the transition from other  container  engines  and
18       allows  the  management  of  pods,  containers and images.  Simply put:
19       alias docker=podman.  Most Podman commands can  be  run  as  a  regular
20       user, without requiring additional privileges.
21
22
23       Podman  uses  Buildah(1)  internally  to  create container images. Both
24       tools share image (not container) storage, hence each can use or manip‐
25       ulate images (but not containers) created by the other.
26
27
28       Podman-remote provides a local client interacting with a Podman backend
29       node through a RESTful API tunneled through a ssh connection.  In  this
30       context,  a  Podman  node is a Linux system with Podman installed on it
31       and the API service activated. Credentials  for  this  session  can  be
32       passed in using flags, environment variables, or in containers.conf.
33
34
35       The  containers.conf file should be placed under $HOME/.config/contain‐
36       ers/containers.conf on Linux and Mac and  %APPDATA%\containers\contain‐
37       ers.conf on Windows.
38
39
40       podman [GLOBAL OPTIONS]
41
42

GLOBAL OPTIONS

44   --connection=name, -c
45       Remote connection name
46
47
48       Overrides environment variable CONTAINER_CONNECTION if set.
49
50
51   --help, -h
52       Print usage statement
53
54
55   --identity=path
56       Path  to  ssh  identity  file. If the identity file has been encrypted,
57       Podman prompts the user for the passphrase.  If  no  identity  file  is
58       provided  and no user is given, Podman defaults to the user running the
59       podman command.  Podman prompts for the login password  on  the  remote
60       server.
61
62
63       Identity value resolution precedence:
64        - command line value
65        - environment variable CONTAINER_SSHKEY, if CONTAINER_HOST is found
66        - containers.conf
67
68
69   --log-level=level
70       Log messages above specified level: debug, info, warn, error (default),
71       fatal or panic
72
73
74   --url=value
75       URL to access Podman service (default  from  containers.conf,  rootless
76       "unix://run/user/$UID/podman/podman.sock"  or  as root "unix://run/pod‐
77       man/podman.sock).
78
79
80CONTAINER_HOST  is  of  the  format  <schema>://[<user[:<pass‐
81                word>]@]<host>[:<port>][<path>]
82
83
84
85       Details:
86        - schema is one of:
87          *  ssh (default): a local unix(7) socket on the named host and port,
88       reachable via SSH
89          * tcp: an unencrypted, unauthenticated TCP connection to  the  named
90       host and port
91          * unix: a local unix(7) socket at the specified path, or the default
92       for the user
93        - user will default to either root or the current  running  user  (ssh
94       only)
95        - password has no default (ssh only)
96        -  host  must  be provided and is either the IP or name of the machine
97       hosting the Podman service (ssh and tcp)
98        - port defaults to 22 (ssh and tcp)
99        -   path    defaults    to    either    /run/podman/podman.sock,    or
100       /run/user/$UID/podman/podman.sock  if  running rootless (unix), or must
101       be explicitly specified (ssh)
102
103
104       URL value resolution precedence:
105        - command line value
106        - environment variable CONTAINER_HOST
107        - containers.conf service_destinations table
108        - unix://run/podman/podman.sock
109
110
111       Remote connections use local containers.conf for default.
112
113
114       Some example URL values in valid formats:
115        - unix://run/podman/podman.sock
116        - unix://run/user/$UID/podman/podman.sock
117        - ssh://notroot@localhost:22/run/user/$UID/podman/podman.sock
118        - ssh://root@localhost:22/run/podman/podman.sock
119        - tcp://localhost:34451
120        - tcp://127.0.0.1:34451
121
122
123   --version
124       Print the version
125
126

Environment Variables

128       Podman can set up environment variables from env of [engine]  table  in
129       containers.conf. These variables can be overridden by passing  environ‐
130       ment variables before the podman commands.
131
132
133   CONTAINERS_CONF
134       Set default locations of containers.conf file
135
136
137   CONTAINER_CONNECTION
138       Set default --connection value to access Podman service.
139
140
141   CONTAINER_HOST
142       Set default --url value to access Podman service.
143
144
145   CONTAINER_SSHKEY
146       Set default --identity path to ssh key file value used to access Podman
147       service.
148
149

Exit Status

151       The  exit  code  from  podman gives information about why the container
152       failed to run or why it exited.  When podman commands exit with a  non-
153       zero code, the exit codes follow the chroot standard, see below:
154
155
156       125 The error is with podman itself
157
158
159              $ podman run --foo busybox; echo $?
160              Error: unknown flag: --foo
161              125
162
163
164
165       126 Executing a contained command and the command cannot be invoked
166
167
168              $ podman run busybox /etc; echo $?
169              Error: container_linux.go:346: starting container process caused "exec: \"/etc\": permission denied": OCI runtime error
170              126
171
172
173
174       127 Executing a contained command and the command cannot be found
175           $ podman run busybox foo; echo $?
176           Error:  container_linux.go:346:  starting  container process caused
177       "exec: \"foo\": executable file not found in $PATH": OCI runtime error
178           127
179
180
181       Exit code contained command exit code
182
183
184              $ podman run busybox /bin/sh -c 'exit 3'; echo $?
185              3
186
187
188

COMMANDS

190       ┌──────────────────────┬────────────────────────────────┐
191Command               Description                    
192       ├──────────────────────┼────────────────────────────────┤
193podman-attach(1)      │ Attach to a running container. │
194       ├──────────────────────┼────────────────────────────────┤
195podman-build(1)       │ Build a container image  using │
196       │                      │ a Dockerfile.                  │
197       ├──────────────────────┼────────────────────────────────┤
198podman-commit(1)      │ Create  new image based on the │
199       │                      │ changed container.             │
200       ├──────────────────────┼────────────────────────────────┤
201podman-container(1)   │ Manage containers.             │
202       ├──────────────────────┼────────────────────────────────┤
203podman-cp(1)          │ Copy files/folders  between  a │
204       │                      │ container    and   the   local │
205       │                      │ filesystem.                    │
206       ├──────────────────────┼────────────────────────────────┤
207podman-create(1)      │ Create a new container.        │
208       ├──────────────────────┼────────────────────────────────┤
209podman-diff(1)        │ Inspect changes on a container │
210       │                      │ or image's filesystem.         │
211       ├──────────────────────┼────────────────────────────────┤
212podman-events(1)      │ Monitor Podman events          │
213       ├──────────────────────┼────────────────────────────────┤
214podman-export(1)      │ Export  a container's filesys‐ │
215       │                      │ tem contents as a tar archive. │
216       ├──────────────────────┼────────────────────────────────┤
217podman-generate(1)    │ Generate structured data based │
218       │                      │ for a containers and pods.     │
219       ├──────────────────────┼────────────────────────────────┤
220podman-healthcheck(1) │ Manage  healthchecks  for con‐ │
221       │                      │ tainers                        │
222       ├──────────────────────┼────────────────────────────────┤
223podman-history(1)     │ Show the history of an image.  │
224       ├──────────────────────┼────────────────────────────────┤
225podman-image(1)       │ Manage images.                 │
226       ├──────────────────────┼────────────────────────────────┤
227podman-images(1)      │ List images in local storage.  │
228       ├──────────────────────┼────────────────────────────────┤
229podman-import(1)      │ Import a tarball and  save  it │
230       │                      │ as a filesystem image.         │
231       ├──────────────────────┼────────────────────────────────┤
232podman-info(1)        │ Displays Podman related system │
233       │                      │ information.                   │
234       ├──────────────────────┼────────────────────────────────┤
235podman-init(1)        │ Initialize a container         │
236       ├──────────────────────┼────────────────────────────────┤
237podman-inspect(1)     │ Display a container or image's │
238       │                      │ configuration.                 │
239       ├──────────────────────┼────────────────────────────────┤
240podman-kill(1)        │ Kill  the  main process in one │
241       │                      │ or more containers.            │
242       ├──────────────────────┼────────────────────────────────┤
243podman-load(1)        │ Load an image from a container │
244       │                      │ image  archive  into container │
245       │                      │ storage.                       │
246       ├──────────────────────┼────────────────────────────────┤
247podman-logs(1)        │ Display the  logs  of  a  con‐ │
248       │                      │ tainer.                        │
249       ├──────────────────────┼────────────────────────────────┤
250podman-pause(1)       │ Pause one or more containers.  │
251       ├──────────────────────┼────────────────────────────────┤
252podman-pod(1)         │ Management  tool for groups of │
253       │                      │ containers, called pods.       │
254       ├──────────────────────┼────────────────────────────────┤
255podman-port(1)        │ List port mappings for a  con‐ │
256       │                      │ tainer.                        │
257       ├──────────────────────┼────────────────────────────────┤
258podman-ps(1)          │ Prints  out  information about │
259       │                      │ containers.                    │
260       ├──────────────────────┼────────────────────────────────┤
261podman-pull(1)        │ Pull an image from a registry. │
262       ├──────────────────────┼────────────────────────────────┤
263podman-push(1)        │ Push an image from local stor‐ │
264       │                      │ age to elsewhere.              │
265       ├──────────────────────┼────────────────────────────────┤
266podman-restart(1)     │ Restart  one  or more contain‐ │
267       │                      │ ers.                           │
268       ├──────────────────────┼────────────────────────────────┤
269podman-rm(1)          │ Remove one or more containers. │
270       ├──────────────────────┼────────────────────────────────┤
271podman-rmi(1)         │ Removes one  or  more  locally │
272       │                      │ stored images.                 │
273       ├──────────────────────┼────────────────────────────────┤
274podman-run(1)         │ Run  a  command  in a new con‐ │
275       │                      │ tainer.                        │
276       ├──────────────────────┼────────────────────────────────┤
277podman-save(1)        │ Save an image to  a  container │
278       │                      │ archive.                       │
279       ├──────────────────────┼────────────────────────────────┤
280podman-start(1)       │ Start one or more containers.  │
281       ├──────────────────────┼────────────────────────────────┤
282podman-stop(1)        │ Stop  one or more running con‐ │
283       │                      │ tainers.                       │
284       ├──────────────────────┼────────────────────────────────┤
285podman-system(1)      │ Manage podman.                 │
286       ├──────────────────────┼────────────────────────────────┤
287podman-tag(1)         │ Add an additional  name  to  a │
288       │                      │ local image.                   │
289       ├──────────────────────┼────────────────────────────────┤
290podman-top(1)         │ Display  the running processes │
291       │                      │ of a container.                │
292       ├──────────────────────┼────────────────────────────────┤
293podman-unpause(1)     │ Unpause one or  more  contain‐ │
294       │                      │ ers.                           │
295       ├──────────────────────┼────────────────────────────────┤
296podman-version(1)     │ Display the Podman version in‐ │
297       │                      │ formation.                     │
298       ├──────────────────────┼────────────────────────────────┤
299podman-volume(1)      │ Manage Volumes.                │
300       └──────────────────────┴────────────────────────────────┘
301

FILES

303       containers.conf ($HOME/.config/containers/containers.conf)
304
305
306       Podman has builtin defaults for command line  options.  These  defaults
307       can be overridden using the containers.conf configuration files.
308
309
310       Users can modify defaults by creating the $HOME/.config/containers/con‐
311       tainers.conf file. Podman merges its builtin defaults with  the  speci‐
312       fied fields from this file, if it exists. Fields specified in the users
313       file override the built-in defaults.
314
315
316       Podman uses builtin defaults if no containers.conf file is found.
317
318

SEE ALSO

320       podman(1), podman-system-service(1), containers.conf(5)
321
322
323
324                                                              podman-remote(1)
Impressum