189 Commits

Author SHA1 Message Date
Jan Rodák
2162404eaf Clarify inspect example in basic setup tutorial
Fixes: https://github.com/containers/podman/issues/28762

Signed-off-by: Jan Rodák <hony.com@seznam.cz>
2026-05-25 10:58:07 +02:00
Jan Rodák
baf8fa6223 Document pasta forwarding mode for rootless bridge networks
Signed-off-by: Jan Rodák <hony.com@seznam.cz>
2026-05-20 14:24:48 +02:00
Paul Holzinger
8c9f530cb3 Merge pull request #28621 from l0rd/import-certs-darwin-linux
Import host trusted certificates into the guest machine - macOS and Linux
2026-05-05 13:10:57 +02:00
Mario Loriedo
3f883706ba Import local certificates to machines on macOS and Linux
This is a follow up of https://github.com/containers/podman/pull/28336 where we
implemented the import of the certificates on Windows. This PR implements the
same feature on macOS and Linux.

Fixes https://redhat.atlassian.net/browse/RUN-4552

Signed-off-by: Mario Loriedo <mario.loriedo@gmail.com>
2026-05-01 00:42:52 +02:00
Mario Loriedo
15c9ca130f Add command podman system hyperv-prep
Introducing a new `podmand system` subcommand to prepare a Windows host
to run Hyper-V based Podman machines: `hyperv-prep`.

When executed it:
- creates of the registry keys for VSocks
- adds the current user to the Hyper-V administrators group

This command requires an administrator terminal.

Signed-off-by: Mario Loriedo <mario.loriedo@gmail.com>
2026-04-29 23:00:29 +02:00
Lokesh Mandvekar
6859a9e512 Remove slirp4netns from documentation
Update all documentation files to remove slirp4netns references
and update to pasta as the only rootless networking backend.

Signed-off-by: Lokesh Mandvekar <lsm5@redhat.com>
2026-04-13 09:04:41 -04:00
Jan Rodák
e39781979e Improve mac_win_client tutorial structure and links
Signed-off-by: Jan Rodák <hony.com@seznam.cz>
2026-03-12 11:14:34 +01:00
Jan Rodák
6637454464 Add tutorial for running podman machine on macOS startup
Add a new tutorial documenting how to use macOS launchd LaunchAgents
to automatically start a Podman machine at login.

Fixes: #28044

Signed-off-by: Jan Rodák <hony.com@seznam.cz>
2026-03-12 11:13:27 +01:00
2190206983@qq.com
176bab3feb docs: update rootless default networking mode
Signed-off-by: sidneychang <2190206983@qq.com>
2026-02-25 23:17:23 +08:00
Jan Rodák
a6a9272430 Merge pull request #27753 from mcgitty/patch-1
docs: Update podman-for-windows.md
2026-02-06 10:09:16 +01:00
Lewis Roy
fc18d3229d [DOCS] Update references common -> container-libs/common
Signed-off-by: Lewis Roy <lewisdenny@me.com>
2026-02-04 21:29:17 +10:00
Alexey Tikhonov
1a5822dc91 rootless_tutorial: mention LDAP support for subid ranges
Signed-off-by: Alexey Tikhonov <atikhono@redhat.com>
2026-02-02 18:14:43 +01:00
Lokesh Mandvekar
721e889476 Update tutorial documentation to remove CNI references
Remove CNI migration instructions and backend selection guidance
from the basic networking tutorial. Simplify DHCP configuration
section to only document netavark setup, removing CNI-specific
instructions.

Signed-off-by: Lokesh Mandvekar <lsm5@redhat.com>
2026-01-27 16:32:38 +05:30
Mario Loriedo
87df3e4749 Update the Podman on Windows tutorial for 6.0.x
Signed-off-by: Mario Loriedo <mario.loriedo@gmail.com>
2026-01-16 11:48:57 +01:00
Mario Loriedo
8bd92f52ab Update the Podman on Windows tutorial for 5.7.x
Signed-off-by: Mario Loriedo <mario.loriedo@gmail.com>
2026-01-13 12:49:33 +01:00
Michael Chen
309f8c0747 Use non-destructive 'set --rootful' command
Signed-off-by: Michael Chen <4326639+mcgitty@users.noreply.github.com>
2025-12-31 12:08:09 -08:00
Jonatan Kazmierczak
e4bd3e6f20 Update rootless_tutorial.md - minor text correction
Signed-off-by: Jonatan Kazmierczak <Jonatan@Son-of-God.info>
2025-12-29 23:59:24 +01:00
MayorFaj
eaf4d4ebc9 fix: remove unnecessary -t flag from podman run commands in documentation
Signed-off-by: MayorFaj <mayorfaj@gmail.com>
2025-12-17 22:29:40 +00:00
Michael Chen
3f49b284f7 Update podman-for-windows.md
Remedy for "ssh: rejected" error commonly seen in corporate PC with reduced permissions.

Signed-off-by: Michael Chen <4326639+mcgitty@users.noreply.github.com>
2025-12-11 11:47:24 -08:00
Manuel Thalmann
58c2fcd2d4 Fix incorrect function call
Changes made in this commit will fix #16168

The current command in the docs expect a `docker.exe` file to exist in the current working directory.
As this is most likely a typo, changes made in this commit fix this issue.

Signed-off-by: Manuel Thalmann <m@nuth.ch>
2025-11-04 12:56:01 -05:00
Manuel Thalmann
2e84246ad5 Update docs for most recent Windows version
In more recent Windows 11 versions (not sure about Windows 10),
Windows now ships its own `curl.exe`,
so PowerShell's "curl"-alias no longer exists.

Changes made in this commit will replace the `curl` alias call with the actual `Invoke-WebRequest` function.

Signed-off-by: Manuel Thalmann <m@nuth.ch>
2025-11-04 12:55:51 -05:00
d2weber
4395ff1f25 Link to blog post
Signed-off-by: d2weber <29163905+d2weber@users.noreply.github.com>
2025-07-21 18:15:01 +02:00
jmozmoz
7a51916e3b Add hint to restart Podman machine to really accept new certificates
Signed-off-by: jmozmoz <joachim.herb@gmx.de>
2025-01-07 00:07:18 +01:00
Bastien Traverse
4a54fd8756 fix(docs): Integrate pasta in rootless tutorial
- rework the slirp4netns section into a general 'Networking configuration' one
- integrate pasta as the new default tool for rootless networking since v5.0
- touch upon the user-facing differences between the two available backends and provide
  links to further documentation, including how to choose between one and the other and
  how to install them

Fixes: #24393

Signed-off-by: Bastien Traverse <neitsab@esrevart.net>
2024-10-29 12:33:01 +01:00
Erik Sjölund
374844817d docs: prefer --network to --net
The option --network is the more official option as it is
listed in

podman run --help
podman kube play --help

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2024-10-05 09:10:15 +02:00
Erik Sjölund
18557659e4 [CI:DOCS] performance: update network docs
* Document that pasta is now the default network driver

* Document command: podman info -f '{{.Host.RootlessNetworkCmd}}'

* Add note about missing network isolation

Fixes: https://github.com/containers/podman/issues/22748

Co-authored-by: Stefano Brivio <sbrivio@redhat.com>
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2024-05-22 08:13:47 +02:00
Erik Sjölund
885dd2addf [CI:DOCS] performance: fix URL and kernel version requirement
Fix broken URL.

Fix kernel version requirement for native overlay rootless support.
Reference: https://www.redhat.com/sysadmin/podman-rootless-overlay

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2024-03-09 16:29:43 +01:00
Jesse Borden
364813da65 Add note for RHEL 8.5
Add note for RHEL 8.5

Signed-off-by: Jesse Borden <40326854+jesseborden@users.noreply.github.com>
2024-03-08 07:02:24 -05:00
Hadir Garcia
e8bf9a323a Update podman-for-windows.md
Signed-off-by: Hadir Garcia <22103698+hadirgax@users.noreply.github.com>
2024-03-04 16:12:30 +00:00
Oleksandr Redko
560455cbd6 docs: fix typos
Signed-off-by: Oleksandr Redko <Oleksandr_Redko@epam.com>
2024-01-04 12:10:11 +02:00
Brent Baude
9a963221b5 [CI:DOCS]use nginx in podman tutorial
the podman tutorial refers to an old httpd image based on Fedora 29.  It
is x86_64 only so Apple Silicon Macs and RPI's cannot follow the
tutorial.  Switch to nginx

Fixes: #20916

[NO NEW TESTS NEEDED]

Signed-off-by: Brent Baude <bbaude@redhat.com>
2023-12-07 07:54:28 -06:00
Erik Sjölund
13e548820e [CI:DOCS] performance: document sometimes slow native overlayfs
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-11-28 12:34:08 +01:00
Ed Santiago
8b2667ef69 More rootless-tutorial fixes
Followup to #20722:

- Fix missing "containers" subdirectory
- Indicate what podman uses as defaults for XDG envariables
- whitespace and quoting fixes (I actually ran pandoc this time)

Signed-off-by: Ed Santiago <santiago@redhat.com>
2023-11-20 07:43:12 -07:00
Ed Santiago
9ea390191b rootless_tutorial: modernize
- We can assume that cgroups v2 and rootless overlayfs are the
  default everywhere.

- Remove RHEL7-only instructions

- add clear '$' and '#' prompts to rootless and root commands

- other minor consistency cleanups

Ref: #20669

Signed-off-by: Ed Santiago <santiago@redhat.com>
2023-11-20 06:04:21 -07:00
Paul Holzinger
f2bc638944 quadlet: document cgroupv2 requirement
Units created with quadlet need cgroupv2 in order to work.

Fixes #19365

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2023-10-19 16:39:55 +02:00
Brent Baude
4796802320 [CI:DOCS]Remove use of --latest|-l from tutorial
Remove the use of the "latest" flags because it cannot be used on
windows or mac.

Fixes #17019

[NO NEW TESTS NEEDED]

Signed-off-by: Brent Baude <bbaude@redhat.com>
2023-09-07 17:57:34 -05:00
Sergio Oller
91b8bc7f13 uid/gid mapping flags
Motivation
===========

This feature aims to make --uidmap and --gidmap easier to use, especially in rootless podman setups.

(I will focus here on the --gidmap option, although the same applies for --uidmap.)

In rootless podman, the user namespace mapping happens in two steps, through an intermediate mapping.

See https://docs.podman.io/en/latest/markdown/podman-run.1.html#uidmap-container-uid-from-uid-amount
for further detail, here is a summary:

First the user GID is mapped to 0 (root), and all subordinate GIDs (defined at /etc/subgid, and
usually >100000) are mapped starting at 1.

One way to customize the mapping is through the `--gidmap` option, that maps that intermediate mapping
to the final mapping that will be seen by the container.

As an example, let's say we have as main GID the group 1000, and we also belong to the additional GID 2000,
that we want to make accessible inside the container.

We first ask the sysadmin to subordinate the group to us, by adding "$user:2000:1" to /etc/subgid.

Then we need to use --gidmap to specify that we want to map GID 2000 into some GID inside the container.

And here is the first trouble:

Since the --gidmap option operates on the intermediate mapping, we first need to figure out where has
podman placed our GID 2000 in that intermediate mapping using:

    podman unshare cat /proc/self/gid_map

Then, we may see that GID 2000 was mapped to intermediate GID 5. So our --gidmap option should include:

    --gidmap 20000:5:1

This intermediate mapping may change in the future if further groups are subordinated to us (or we stop
having its subordination), so we are forced to verify the mapping with
`podman unshare cat /proc/self/gid_map` every time, and parse it if we want to script it.

**The first usability improvement** we agreed on #18333 is to be able to use:

    --gidmap 20000:@2000:1

so podman does this lookup in the parent user namespace for us.

But this is only part of the problem. We must specify a **full** gidmap and not only what we want:

    --gidmap 0:0:5 --gidmap 5:6:15000 --gidmap 20000:5:1

This is becoming complicated. We had to break the gidmap at 5, because the intermediate 5 had to
be mapped to another value (20000), and then we had to keep mapping all other subordinate ids... up to
close to the maximum number of subordinate ids that we have (or some reasonable value). This is hard
to explain to someone who does not understand how the mappings work internally.

To simplify this, **the second usability improvement** is to be able to use:

   --gidmap "+20000:@2000:1"

where the plus flag (`+`) states that the given mapping should extend any previous/default mapping,
overriding any previous conflicting assignment.

Podman will set that mapping and fill the rest of mapped gids with all other subordinated gids, leading
to the same (or an equivalent) full gidmap that we were specifying before.

One final usability improvement related to this is the following:

By default, when podman  gets a --gidmap argument but not a --uidmap argument, it copies the mapping.
This is convenient in many scenarios, since usually subordinated uids and gids are assigned in chunks
simultaneously, and the subordinated IDs in /etc/subuid and /etc/subgid for a given user match.

For scenarios with additional subordinated GIDs, this map copying is annoying, since it forces the user
to provide a --uidmap, to prevent the copy from being made. This means, that when the user wants:

    --gidmap 0:0:5 --gidmap 5:6:15000 --gidmap 20000:5:1

The user has to include a uidmap as well:

    --gidmap 0:0:5 --gidmap 5:6:15000 --gidmap 20000:5:1 --uidmap 0:0:65000

making everything even harder to understand without proper context.

For this reason, besides the "+" flag, we introduce the "u" and "g" flags. Those flags applied to a
mapping tell podman that the mapping should only apply to users or groups, and ignored otherwise.

Therefore we can use:

   --gidmap "+g20000:@2000:1"

So the mapping only applies to groups and is ignored for uidmaps. If no "u" nor "g" flag is assigned
podman assumes the mapping applies to both users and groups as before, so we preserve backwards compatibility.

Co-authored-by: Tom Sweeney <tsweeney@redhat.com>
Signed-off-by: Sergio Oller <sergioller@gmail.com>
2023-08-28 20:21:04 +02:00
Will Thompson
68bd81470a Add missing verb in machinectl example
Without the verb 'shell', the invocation fails with:

    Unknown command verb testuser@

Signed-off-by: Will Thompson <will@willthompson.co.uk>
2023-08-13 11:52:56 +01:00
Erik Sjölund
5ba0559377 [CI:DOCS] socket_activation.md: increase socat timeout
The default socat timeout is 0.5 seconds.
Make the socket-activate-echo example in socket_activation.md
more robust by increasing the socat timeout.

Fixes: https://github.com/containers/podman/issues/19373

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-07-26 17:52:33 +02:00
Daniel J Walsh
1f455cf619 Merge pull request #19320 from eriksjolund/remove_unnecessary_please
Remove unnecessary use of the word "please"
2023-07-25 15:20:38 -04:00
Daniel J Walsh
03ea93c21b Merge pull request #19323 from eriksjolund/fix_language_typos_markdown_layout
Fix language, typos and markdown layout
2023-07-24 10:56:11 -04:00
Erik Sjölund
baf30e6120 [CI:DOCS] migrate socket_activation.md to quadlet
Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-07-24 15:01:33 +02:00
Erik Sjölund
b5ce0ab2de Fix language, typos and markdown layout
[NO NEW TESTS NEEDED]

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-07-24 11:18:25 +02:00
Erik Sjölund
d4cfc498d7 Remove unnecessary use of the word "please".
Only use the word "please" in these situations:

- reader is asked to do something inconvenient
- reader is asked for permission
- reader is asked for forgiveness

Remove other uses of the word "please" to
make the language more efficient.

[NO NEW TESTS NEEDED]

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-07-23 17:31:29 +02:00
Black-Hole1
d15cca0246 [CI:DOCS] fix command incorrect in windows
Signed-off-by: Black-Hole1 <bh@bugs.cc>
2023-06-28 09:23:51 +08:00
Erik Sjölund
685c736185 source code comments and docs: fix typos, language, Markdown layout
- fix a/an before noun
- fix loose -> lose
- fix "the the"
- fix lets -> let's
- fix Markdown layout
- fix a few typos
- remove unnecessary text in troubleshooting.md

Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
2023-05-22 07:52:16 +02:00
Paul Holzinger
e7a3236358 docs: update network tutorial with netavark DHCP support
Add instructions on how to start the netavark dhcp proxy. Also list
version requirements.

Fixes #17635

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2023-04-14 12:16:26 +02:00
OpenShift Merge Robot
f3c5c8fb05 Merge pull request #17994 from stickM4N/patch-1
Update podman-for-windows.md
2023-04-03 10:23:46 -04:00
Julio C. Galindo
5643058c8a Update podman-for-windows.md
Signed-off-by: Julio C. Galindo <54072664+stickM4N@users.noreply.github.com>
2023-03-30 17:20:12 -04:00
tomsweeneyredhat
b7a8e12859 [CI:DOCS] Improve basic tutorial
Finishing up the work started by @biergit in #17021

Updates the tutorial to explain the use of `-l/--latest`
and converts many of the examples to use `<container_id>`
as that works locally and remote while `-l` doesn't always.

Thanks for the start on this @biergit !

[NO NEW TESTS NEEDED]

Signed-off-by: tomsweeneyredhat <tsweeney@redhat.com>
2023-03-28 20:08:47 -04:00