1podman-remote(1)()                                          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   --help, -h
49       Print usage statement
50
51
52   --identity=path
53       Path  to  ssh  identity  file. If the identity file has been encrypted,
54       Podman prompts the user for the passphrase.  If  no  identity  file  is
55       provided  and no user is given, Podman defaults to the user running the
56       podman command.  Podman prompts for the login password  on  the  remote
57       server.
58
59
60       Identity value resolution precedence:
61        - command line value
62        - environment variable CONTAINER_SSHKEY, if CONTAINER_HOST is found
63        - containers.conf
64
65
66   --log-level=level
67       Log messages above specified level: debug, info, warn, error (default),
68       fatal or panic
69
70
71   --url=value
72       URL to access Podman service (default  from  containers.conf,  rootless
73       "unix://run/user/$UID/podman/podman.sock"  or  as root "unix://run/pod‐
74       man/podman.sock).
75
76
77CONTAINER_HOST  is  of  the  format  <schema>://[<user[:<pass‐
78                word>]@]<host>[:<port>][<path>]
79
80
81
82       Details:
83        - user will default to either root or current running user
84        - password has no default
85        -  host  must  be provided and is either the IP or name of the machine
86       hosting the Podman service
87        - port defaults to 22
88        -   path    defaults    to    either    /run/podman/podman.sock,    or
89       /run/user/<uid>/podman/podman.sock if running rootless.
90
91
92       URL value resolution precedence:
93        - command line value
94        - environment variable CONTAINER_HOST
95        - containers.conf
96        - unix://run/podman/podman.sock
97
98
99   --version
100       Print the version
101
102

Exit Status

104       The  exit  code  from  podman gives information about why the container
105       failed to run or why it exited.  When podman commands exit with a  non-
106       zero code, the exit codes follow the chroot standard, see below:
107
108
109       125 The error is with podman itself
110
111
112              $ podman run --foo busybox; echo $?
113              Error: unknown flag: --foo
114              125
115
116
117
118       126 Executing a contained command and the command cannot be invoked
119
120
121              $ podman run busybox /etc; echo $?
122              Error: container_linux.go:346: starting container process caused "exec: \"/etc\": permission denied": OCI runtime error
123              126
124
125
126
127       127 Executing a contained command and the command cannot be found
128           $ podman run busybox foo; echo $?
129           Error:  container_linux.go:346:  starting  container process caused
130       "exec: \"foo\": executable file not found in $PATH": OCI runtime error
131           127
132
133
134       Exit code contained command exit code
135
136
137              $ podman run busybox /bin/sh -c 'exit 3'; echo $?
138              3
139
140
141

COMMANDS

143       ┌──────────────────────┬────────────────────────────────┐
144Command               Description                    
145       ├──────────────────────┼────────────────────────────────┤
146podman-attach(1)      │ Attach to a running container. │
147       ├──────────────────────┼────────────────────────────────┤
148podman-build(1)       │ Build a container image  using │
149       │                      │ a Dockerfile.                  │
150       ├──────────────────────┼────────────────────────────────┤
151podman-commit(1)      │ Create  new image based on the │
152       │                      │ changed container.             │
153       ├──────────────────────┼────────────────────────────────┤
154podman-container(1)   │ Manage containers.             │
155       ├──────────────────────┼────────────────────────────────┤
156podman-cp(1)          │ Copy files/folders  between  a │
157       │                      │ container    and   the   local │
158       │                      │ filesystem.                    │
159       ├──────────────────────┼────────────────────────────────┤
160podman-create(1)      │ Create a new container.        │
161       ├──────────────────────┼────────────────────────────────┤
162podman-diff(1)        │ Inspect changes on a container │
163       │                      │ or image's filesystem.         │
164       ├──────────────────────┼────────────────────────────────┤
165podman-events(1)      │ Monitor Podman events          │
166       ├──────────────────────┼────────────────────────────────┤
167podman-export(1)      │ Export  a container's filesys‐ │
168       │                      │ tem contents as a tar archive. │
169       ├──────────────────────┼────────────────────────────────┤
170podman-generate(1)    │ Generate structured data based │
171       │                      │ for a containers and pods.     │
172       ├──────────────────────┼────────────────────────────────┤
173podman-healthcheck(1) │ Manage  healthchecks  for con‐ │
174       │                      │ tainers                        │
175       ├──────────────────────┼────────────────────────────────┤
176podman-history(1)     │ Show the history of an image.  │
177       ├──────────────────────┼────────────────────────────────┤
178podman-image(1)       │ Manage images.                 │
179       ├──────────────────────┼────────────────────────────────┤
180podman-images(1)      │ List images in local storage.  │
181       ├──────────────────────┼────────────────────────────────┤
182podman-import(1)      │ Import a tarball and  save  it │
183       │                      │ as a filesystem image.         │
184       ├──────────────────────┼────────────────────────────────┤
185podman-info(1)        │ Displays Podman related system │
186       │                      │ information.                   │
187       ├──────────────────────┼────────────────────────────────┤
188podman-init(1)        │ Initialize a container         │
189       ├──────────────────────┼────────────────────────────────┤
190podman-inspect(1)     │ Display a container or image's │
191       │                      │ configuration.                 │
192       ├──────────────────────┼────────────────────────────────┤
193podman-kill(1)        │ Kill  the  main process in one │
194       │                      │ or more containers.            │
195       ├──────────────────────┼────────────────────────────────┤
196podman-load(1)        │ Load an image from a container │
197       │                      │ image  archive  into container │
198       │                      │ storage.                       │
199       ├──────────────────────┼────────────────────────────────┤
200podman-logs(1)        │ Display the  logs  of  a  con‐ │
201       │                      │ tainer.                        │
202       ├──────────────────────┼────────────────────────────────┤
203podman-pause(1)       │ Pause one or more containers.  │
204       ├──────────────────────┼────────────────────────────────┤
205podman-pod(1)         │ Management  tool for groups of │
206       │                      │ containers, called pods.       │
207       ├──────────────────────┼────────────────────────────────┤
208podman-port(1)        │ List port mappings for a  con‐ │
209       │                      │ tainer.                        │
210       ├──────────────────────┼────────────────────────────────┤
211podman-ps(1)          │ Prints  out  information about │
212       │                      │ containers.                    │
213       ├──────────────────────┼────────────────────────────────┤
214podman-pull(1)        │ Pull an image from a registry. │
215       ├──────────────────────┼────────────────────────────────┤
216podman-push(1)        │ Push an image from local stor‐ │
217       │                      │ age to elsewhere.              │
218       ├──────────────────────┼────────────────────────────────┤
219podman-restart(1)     │ Restart  one  or more contain‐ │
220       │                      │ ers.                           │
221       ├──────────────────────┼────────────────────────────────┤
222podman-rm(1)          │ Remove one or more containers. │
223       ├──────────────────────┼────────────────────────────────┤
224podman-rmi(1)         │ Removes one  or  more  locally │
225       │                      │ stored images.                 │
226       ├──────────────────────┼────────────────────────────────┤
227podman-run(1)         │ Run  a  command  in a new con‐ │
228       │                      │ tainer.                        │
229       ├──────────────────────┼────────────────────────────────┤
230podman-save(1)        │ Save an image to  a  container │
231       │                      │ archive.                       │
232       ├──────────────────────┼────────────────────────────────┤
233podman-start(1)       │ Start one or more containers.  │
234       ├──────────────────────┼────────────────────────────────┤
235podman-stop(1)        │ Stop  one or more running con‐ │
236       │                      │ tainers.                       │
237       ├──────────────────────┼────────────────────────────────┤
238podman-system(1)      │ Manage podman.                 │
239       ├──────────────────────┼────────────────────────────────┤
240podman-tag(1)         │ Add an additional  name  to  a │
241       │                      │ local image.                   │
242       ├──────────────────────┼────────────────────────────────┤
243podman-top(1)         │ Display  the running processes │
244       │                      │ of a container.                │
245       ├──────────────────────┼────────────────────────────────┤
246podman-unpause(1)     │ Unpause one or  more  contain‐ │
247       │                      │ ers.                           │
248       ├──────────────────────┼────────────────────────────────┤
249podman-version(1)     │ Display the Podman version in‐ │
250       │                      │ formation.                     │
251       ├──────────────────────┼────────────────────────────────┤
252podman-volume(1)      │ Manage Volumes.                │
253       └──────────────────────┴────────────────────────────────┘
254

FILES

256       containers.conf ($HOME/.config/containers/containers.conf)
257
258
259       Podman has builtin defaults for command line  options.  These  defaults
260       can be overridden using the containers.conf configuration files.
261
262
263       Users can modify defaults by creating the $HOME/.config/containers/con‐
264       tainers.conf file. Podman merges its builtin defaults with  the  speci‐
265       fied fields from this file, if it exists. Fields specified in the users
266       file override the built-in defaults.
267
268
269       Podman uses builtin defaults if no containers.conf file is found.
270
271

SEE ALSO

273       containers.conf(5)
274
275
276
277                                                            podman-remote(1)()
Impressum