aboutsummaryrefslogtreecommitdiff
path: root/docs/tutorials
Commit message (Collapse)AuthorAge
* [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>
* Cleanup tutorialsDaniel J Walsh2020-11-17
| | | | | | | | | | | | | | | Inspired by @kannkyo PR. Eliminate sudo when commands will work fine in rootless mode. Make all commands in tutorials easily cut and pastable, by eliminating $ and > symbols. This should make them all consistant agross different tutorials. Also make all systemctl enable calls use the --now option. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* Add missing --now in systemctl start commandBenjamin Porter2020-11-12
| | | | | | | | If you don't use --now or also run systemctl --user start podman.socket then the socket won't start until a reboot. Much easier to just start the socket at the same time as enabling it. Signed-off-by: Benjamin Porter <FreedomBen@users.noreply.github.com>
* Update README.mdJJ Asghar2020-11-02
| | | | | | Typo Signed-off-by: JJ Asghar <jjasghar@gmail.com>
* Update rootless_tutorial.mdDaniel J Walsh2020-10-01
| | | | | | | add clarifications in persistently setting unprivileged ping permissions Signed-off-by: fuzxi <opuspam@posteo.de> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* [CI:DOCS] Update remote tutorialsAshley Cui2020-09-08
| | | | | | | | update remote tutorial update mac/windows tutorial move varlink tutorial Signed-off-by: Ashley Cui <acui@redhat.com>
* [CI:DOCS] Include Go bindings tutorialLokesh Mandvekar2020-08-19
| | | | | | Include the Go bindings blog post as a tutorial Signed-off-by: Lokesh Mandvekar <lsm5@fedoraproject.org>
* Merge pull request #6909 from rhatdan/podmanOpenShift Merge Robot2020-07-28
|\ | | | | Switch all references to github.com/containers/libpod -> podman
| * Switch all references to github.com/containers/libpod -> podmanDaniel J Walsh2020-07-28
| | | | | | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Merge pull request #7079 from rhatdan/tuturialOpenShift Merge Robot2020-07-28
|\ \ | |/ |/| update configuration for rootless podman
| * update configuration for rootless podmanDaniel J Walsh2020-07-25
| | | | | | | | | | | | | | | | | | | | | | I updated the configuration part of the tutorial on rootless podman. I added the order in which configuration files are read in and a hint, how users can create default configuration in the home directories. Closes #6777 Signed-off-by: Niklas Netter <niknett@gmail.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* | Corrects typo in the name of the Linux package shadow-utils.Melykuti2020-07-27
|/ | | | Signed-off-by: Bence Mélykúti <bence.melykuti@gmail.com>
* Switch references from libpod.conf to containers.confDaniel J Walsh2020-07-20
| | | | Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
* [CI:DOCS] update httpd location in tutorialTomSweeneyRedHat2020-05-30
| | | | | | | | | | | Update the reference to the httpd in the Podman tutorial. This just bumps it to F29 for now to get things working, I'd prefer to get something set up in quay.io to make it more resistant to Fedora version changes. Fixes: #6439 Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* [CI:DOCS] Tweak casing in rootless docTomSweeneyRedHat2020-05-26
| | | | | | | I just noticed a few 'podman' references that should be 'Podman' in the rootless doc. This fixes it. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Merge pull request #6309 from cortopy/nonroot_vol_docsOpenShift Merge Robot2020-05-24
|\ | | | | add section on rootless volumes in the docs
| * add section on rootless volumesJuan Jimenez-Anca2020-05-23
| | | | | | | | Signed-off-by: Juan Jimenez-Anca <cortopy@users.noreply.github.com>
* | Update Derivative API tutorial to reflect the HTTP APIMatthew Heon2020-05-20
|/ | | | | | | | Once the HTTP API becomes stable, I think we want to drive people towards using it, as opposed to directly calling our CLI (when possible). Signed-off-by: Matthew Heon <matthew.heon@pm.me>
* Add image signing with GPG tutorialSascha Grunert2020-03-23
| | | | Signed-off-by: Sascha Grunert <sgrunert@suse.com>
* rootles tutorial: remove systemd unit exampleValentin Rothberg2020-03-09
| | | | | | | | | | The example was not entirely correct. Users should use `podman generate systemd` and use the output either directly or as a template for further adjustments to their needs. Keeping an example in the rootless tutorial is a maintenance burdon and can easily suggest incorrect usage patterns to users. Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
* Enhance fuse-overlayfs instructions.Leonardo Rochael Almeida2020-02-13
| | | | | | | | | | | The `fuse-overlayfs` package provided by Ubuntu up to 19.10, is not recent enough and causes errors on `buildah commit`, for instance. Adjust the rootless tutorial to point this out and to provide more detailed instructions on how to obtain `fuse-overlayfs` and configure it for use by `libpod`. Signed-off-by: Leonardo Rochael Almeida <leorochael@gmail.com>
* Update remote client bridge documentation.Jhon Honce2020-01-28
| | | | | | * Add PODMAN_VARLINK_BRIDGE examples. Signed-off-by: Jhon Honce <jhonce@redhat.com>
* Markdown Formatting FixesSteven Gubler2019-10-18
| | | | Signed-off-by: Steven Gubler <stevegubler@protonmail.com>
* Add api link to tutorialsTomSweeneyRedHat2019-10-02
| | | | | | | | We recently moved the "How to use libpod for custom/derivative projects" page to the docs/tutorials directory. This adds a link to the README.md there so it can be more easily found and adds a logo to the tutorial itself. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
* Move derivitive doc so it won't be treated as a manpageMatthew Heon2019-09-30
| | | | | | | | | Anything with the .md suffix in docs/ gets compiled into a manpage, so let's get things that aren't manpages out of there. This isn't precisely a tutorial, but it seems like the next best place. Signed-off-by: Matthew Heon <mheon@redhat.com>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-09-27 19:24:45 +0000