aboutsummaryrefslogtreecommitdiff
path: root/docs/tutorials
Commit message (Collapse)AuthorAge
* Merge pull request #15087 from eriksjolund/socket_activation.md_clarify_delayOpenShift Merge Robot2022-07-27
|\ | | | | [CI:DOCS] socket_activation.md: Add start/stop sections
| * [CI:DOCS] socket_activation.md: Add start/stop sectionsErik Sjölund2022-07-27
| | | | | | | | | | | | | | | | | | | | | | | | * Add section "Starting a socket-activated service". * Add section "Stopping a socket-activated service". * Clarify in the diagrams that socket activation only happens for the first client connection. Co-authored-by: Valentin Rothberg <vrothberg@redhat.com> Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | docs: remove CNI word where it is not applicablePaul Holzinger2022-07-22
|/ | | | | | | | | | Most network commands/features work with both netavark and CNI. When we added added netavark most docs were not vetted and thus still use CNI network, it should just say network. Fixes #14990 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
* [CI:DOCS] socket_activation.md: fix typo and layoutErik Sjölund2022-07-16
| | | | Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* Merge pull request #14909 from eriksjolund/add_socket_activation_tutorialopenshift-ci[bot]2022-07-15
|\ | | | | [CI:DOCS] Add socket_activation.md
| * [CI:DOCS] Update docs/tutorials/socket_activation.mdErik Sjölund2022-07-14
| | | | | | | | | | Co-authored-by: Valentin Rothberg <vrothberg@redhat.com> Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
| * [CI:DOCS] Add socket activation tutorialErik Sjölund2022-07-14
| | | | | | | | | | | | Closes #14908 Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* | [CI:DOCS] rootless_tutorial: Remove incorrect advice regarding volumes and ↵Erik Sjölund2022-07-12
|/ | | | | | | | | | | | | | | | | | | | | | | | mount points * Remove the instruction "The mount point must exist in the container" as it is incorrect which is shown by this example ``` $ mkdir dir1 $ podman run --rm -v ./dir1:/dir1:Z docker.io/library/fedora:36 touch /dir1/file $ ls dir1 file $ podman run --rm docker.io/library/fedora:36 ls -l /dir1 ls: cannot access '/dir1': No such file or directory $ podman --version podman version 4.1.1 $ ``` * Rewrite the advice "You should always give the full path to the volume you'd like to mount" so that it also mentions relative paths starting with a dot. Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* docs: Remove -s from systemctl enable --now sshdMichael Vorburger ⛑️2022-07-02
| | | | | This flag does not work (e.g. on Fedora 36) and not appear to be required (anymore?). Signed-off-by: Michael Vorburger ⛑️ <mike@vorburger.ch>
* Fix spelling "setup" -> "set up" and similarErik Sjölund2022-06-22
| | | | | | | | | | * Replace "setup", "lookup", "cleanup", "backup" with "set up", "look up", "clean up", "back up" when used as verbs. Replace also variations of those. * Improve language in a few places. Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* Merge pull request #14688 from rhatdan/docsopenshift-ci[bot]2022-06-22
|\ | | | | [CI:DOCS] Update basic_networking.md
| * Update basic_networking.mdgunnar2022-06-21
| | | | | | | | | | | | | | | | | | a little enhancement based on the [comment by @TomSweeneyRedHat](https://github.com/containers/podman/pull/14290#pullrequestreview-979316099) Replaces: https://github.com/containers/podman/pull/14290 Thanks to @vrms Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Open Windows tutorial after MSI installationJason T. Greene2022-06-16
|/ | | | Signed-off-by: Jason T. Greene <jason.greene@redhat.com>
* Update remote_client.mdChristopher 'm4z' Holm2022-06-08
| | | | | | | | | Explicitly include copy-and-paste code line for `ssh-copy-id` because people like myself will easily forget this part and (repeatedly) overlook it in the text. :blush: Supersedes #14445 and attempts to address review by @TomSweeneyRedHat there (but enforcing a filename instead of using a placeholder). Signed-off-by: Christopher 'm4z' Holm <them4z@gmail.com> Signed-off-by: Christopher 'm4z' Holm <them4z@googlemail.com>
* Add docs of changing default netavark networksTobias Florek2022-06-07
| | | | Signed-off-by: Tobias Florek <tob@butter.sh>
* Put current product first and historical product secondWilliam Entriken2022-05-24
| | | | Signed-off-by: William Entriken <github.com@phor.net>
* fix podman-for-windows.mdYuta2022-05-21
| | | | Signed-off-by: Yuta <yuta_mori@outlook.jp>
* Update tutorial list to include Podman for WindowsJason T. Greene2022-05-15
| | | | | | Label remote client tutorial as advanced so that users favor the managed machine approach. Signed-off-by: Jason T. Greene <jason.greene@redhat.com>
* Add initial Windows guideJason T. Greene2022-05-10
| | | | Signed-off-by: Jason T. Greene <jason.greene@redhat.com>
* Merge pull request #14123 from DE0CH/rootless_tutorialOpenShift Merge Robot2022-05-05
|\ | | | | [CI:DOCS] Update rootless_tutorial.md
| * update rootless_tutorial.mdDeyao Chen2022-05-05
| | | | | | | | | | | | | | The links to the installation instructions and build instructions seem to be outdated, so this PR updates them. Signed-off-by: Deyao Chen <chendeyao000@gmail.com>
* | Fix usermod call in rootless_tutorial.mdDan Čermák2022-05-05
|/ | | | | | | | The `usermod` calls in rootless_tutorial.md were only adding a very narrow range for subuids and subgids, which will cause failures with containers where a file is owned by a user or group with a uid/gid > 1001. Signed-off-by: Dan Čermák <dcermak@suse.com>
* Docs rootfull -> rootfulAshley Cui2022-04-25
| | | | | | | | Some docs say roofull. Change to rootful. [NO NEW TESTS NEEDED] Signed-off-by: Ashley Cui <acui@redhat.com>
* [CI:DOCS]Update networking tutorial for netavarkBrent Baude2022-02-21
| | | | | | | | | With netavark being the default networking implementation for Podman v4, the tutorial needed some updating. [NO NEW TESTS] Signed-off-by: Brent Baude <bbaude@redhat.com>
* [CI:DOCS] fix default branch linksErik Sjölund2022-01-15
| | | | | | | | | | * Replace https://github.com/containers/podman/blob/master with https://github.com/containers/podman/blob/main to match the new default branch "main". Previously the default branch was "master". The substitutions were made in the documentation but not the code. Signed-off-by: Erik Sjölund <erik.sjolund@gmail.com>
* [CI:DOCS] Add example of cpus to init commandAnders F Björklund2021-12-30
| | | | Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
* Update Windows Install DocTomSweeneyRedHat2021-12-14
| | | | | | | | Updates the Windows install doc to make it more clear. Fixes: #11382 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Update doc to explictly mention using ed25519 in ssh keysHongyi Shen2021-12-02
| | | | Signed-off-by: Hongyi Shen <wilbeibi@gmail.com>
* Update basic_networking.mdMark Zhang2021-11-23
| | | | | | Correct a missing link in basic networking tutorial. Signed-off-by: Mark Zhang <markzhang1994@gmail.com>
* [CI:DOCS]upload a translation file二氟化氧2021-11-19
| | | | | | a tranlastion for the podman_tutorial.md Signed-off-by: sixways <lw.2675@qq.com>
* Example says there is not IP then in the next command suggests to use itFabien Benetou2021-09-05
| | | | Signed-off-by: Utopiah <fabien-services@benetou.fr>
* Correct a typo in documentationGuido Aulisi2021-07-15
| | | | Signed-off-by: Guido Aulisi <guido.aulisi@gmail.com>
* Merge pull request #10872 from ebb-earl-co/rootless_tutorial_revisionOpenShift Merge Robot2021-07-09
|\ | | | | [CI:DOCS] Update docs/tutorials/rootless_tutorial.md:
| * Update docs/tutorials/rootless_tutorial.md:Colin Eberl Coe2021-07-08
| | | | | | | | | | | | | | | | | | | | | | | | | | * Change references of 'master' to 'main' in URLs e.g. https://github.com/containers/podman/blob/main/install.md * Wrap names of files or programs by '`' e.g. `dnf`, `containers.conf`, `/etc/subuid`, etc. * Change sentence with ambiguous subject to 'Root privileges are required to add or update entries within these files' * Link to kernel.org documentation for the `getpwent` command * Change sentence: 'Note that the values for each user must be unique ~and without any overlap~' * Make references to the Podman project upper-case instead of lower-case * Reorder sentence 'Update the `/etc/subuid` and `/etc/subgid` with fields for each user' to emphasize 'For each user' * Remove reference to asciiart demos and update README.md link Signed-off-by: Colin Eberl Coe <ebb-earl-co@pm.me>
* | Replace old RESTful tutorial with updated READMEBrent Baude2021-07-07
|/ | | | | | | | | | | Remove outdated information on go bindings. Moved the tips for debugging into the REAME and tidied up relevant links. Fixes: #9334 [CI_DOCS] [NO TESTS NEEDED] Signed-off-by: Brent Baude <bbaude@redhat.com>
* [CI:DOCS]instructions for podman machine on macsBrent Baude2021-06-07
| | | | | | | first pass for instructions on using podman machine on Intel and M1 macs. Signed-off-by: Brent Baude <bbaude@redhat.com>
* Merge pull request #10574 from rogercoll/fix-bindings-docsOpenShift Merge Robot2021-06-06
|\ | | | | [CI:DOCS] Fix outdated docs
| * fix go-bindings examples with v3 new parametersRoger Coll2021-06-05
| | | | | | | | Signed-off-by: Roger Coll <rogercoll@protonmail.com>
* | extend docs to include help for when pub/priv key is signed with an ↵alex narayan2021-06-03
|/ | | | | | unsupported algo Signed-off-by: alex narayan <alexandar.narayan@deliveryhero.com>
* network tutorial: update with rootless cni changesPaul Holzinger2021-05-15
| | | | | | | | Starting with podman v3.2 rootless cni will work without the rootless-cni-infra container. Update the network tutorial to reflect the latest changes and mention that the infra container can be removed. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* Add documentation on short-namesDaniel J Walsh2021-05-07
| | | | | | | | | Once we settle on the wording for short-names in podman-pull, I will add the same section to all of the podman commands that use pull. Also ran through all man pages with a spell checker. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Fix wrong macvlan PNG in networking doc.Sebastian Boerakker2021-05-06
| | | | Signed-off-by: Sebastian Boerakker <sebboer@protonmail.com>
* Merge pull request #9335 from rlukin/patch-1OpenShift Merge Robot2021-02-22
|\ | | | | [ci:docs] Update rootless_tutorial.md
| * Fix 'storage.options' indentRoman2021-02-21
| | | | | | | | Signed-off-by: Roman Lukin <me@rlukin.ru>
* | bump go module to v3Valentin Rothberg2021-02-22
| | | | | | | | | | | | | | | | | | We missed bumping the go module, so let's do it now :) * Automated go code with github.com/sirkon/go-imports-rename * Manually via `vgrep podman/v2` the rest Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* | [CI:DOCS]basic networking guidebaude2021-02-18
|/ | | | | | | | | created a basic networking guide for podman that outlines the common network setups for podman. Fixes: #8874 Signed-off-by: baude <bbaude@redhat.com>
* typoMatthew Cengia2021-02-03
| | | | Signed-off-by: Matthew Cengia <mattcen@mattcen.com>
* Switch references of /var/run -> /runDaniel J Walsh2021-01-07
| | | | | | | | | | Systemd is now complaining or mentioning /var/run as a legacy directory. It has been many years where /var/run is a symlink to /run on all most distributions, make the change to the default. Partial fix for https://github.com/containers/podman/issues/8369 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Remove varlink support from PodmanDaniel J Walsh2020-11-26
| | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* [tutorials:mac-win-client] Fix command ensuring sshd is enabledLucendio2020-11-24
| | | | | | `-s, --signal` requires a value and is probably not intended to be here Signed-off-by: Lucendio <dev@lucend.io>