Commit Graph

93 Commits

Author SHA1 Message Date
Erik Sjölund d6e55577cf [CI:DOCS] fix default branch links
* 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>
2022-01-15 20:56:19 +01:00
Anders F Björklund ec32430a06 [CI:DOCS] Add example of cpus to init command
Signed-off-by: Anders F Björklund <anders.f.bjorklund@gmail.com>
2021-12-30 13:32:30 +01:00
TomSweeneyRedHat afdb4dc22f Update Windows Install Doc
Updates the Windows install doc to make it more clear.

Fixes: #11382

Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
2021-12-14 11:23:32 -05:00
Hongyi Shen babc693670 Update doc to explictly mention using ed25519 in ssh keys
Signed-off-by: Hongyi Shen <wilbeibi@gmail.com>
2021-12-02 09:20:13 -08:00
Mark Zhang 5336363957 Update basic_networking.md
Correct a missing link in basic networking tutorial.

Signed-off-by: Mark Zhang <markzhang1994@gmail.com>
2021-11-23 23:43:32 +08:00
二氟化氧 a3664269b9
[CI:DOCS]upload a translation file
a tranlastion for the podman_tutorial.md

Signed-off-by: sixways <lw.2675@qq.com>
2021-11-19 21:29:28 +08:00
Fabien Benetou ebd37ede99 Example says there is not IP then in the next command suggests to use it
Signed-off-by: Utopiah <fabien-services@benetou.fr>
2021-09-05 17:23:21 +02:00
Guido Aulisi ec61507514 Correct a typo in documentation
Signed-off-by: Guido Aulisi <guido.aulisi@gmail.com>
2021-07-15 17:01:16 +02:00
OpenShift Merge Robot 43abe006a3
Merge pull request #10872 from ebb-earl-co/rootless_tutorial_revision
[CI:DOCS] Update docs/tutorials/rootless_tutorial.md:
2021-07-09 10:36:08 -04:00
Colin Eberl Coe 95c4637851
Update docs/tutorials/rootless_tutorial.md:
* 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>
2021-07-08 13:38:05 -05:00
Brent Baude 38863e7642 Replace old RESTful tutorial with updated README
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>
2021-07-07 10:03:01 -05:00
Brent Baude f6d9dbb625 [CI:DOCS]instructions for podman machine on macs
first pass for instructions on using podman machine on Intel and M1
macs.

Signed-off-by: Brent Baude <bbaude@redhat.com>
2021-06-07 16:17:13 -05:00
OpenShift Merge Robot 45fdd8f5c5
Merge pull request #10574 from rogercoll/fix-bindings-docs
[CI:DOCS] Fix outdated docs
2021-06-06 22:44:42 +02:00
Roger Coll 13a807b860 fix go-bindings examples with v3 new parameters
Signed-off-by: Roger Coll <rogercoll@protonmail.com>
2021-06-05 22:21:43 +02:00
alex narayan b928278e63 extend docs to include help for when pub/priv key is signed with an unsupported algo
Signed-off-by: alex narayan <alexandar.narayan@deliveryhero.com>
2021-06-03 18:40:31 +02:00
Paul Holzinger 460182dc5d network tutorial: update with rootless cni changes
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>
2021-05-15 22:46:53 +02:00
Daniel J Walsh bdbce9bcb1
Add documentation on short-names
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>
2021-05-07 09:00:35 -04:00
Sebastian Boerakker c7178958ca Fix wrong macvlan PNG in networking doc.
Signed-off-by: Sebastian Boerakker <sebboer@protonmail.com>
2021-05-06 13:54:20 +02:00
OpenShift Merge Robot 5da7c69968
Merge pull request #9335 from rlukin/patch-1
[ci:docs] Update rootless_tutorial.md
2021-02-22 08:57:33 -05:00
Valentin Rothberg 5dded6fae7 bump go module to v3
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>
2021-02-22 09:03:51 +01:00
Roman d333ef82b1 Fix 'storage.options' indent
Signed-off-by: Roman Lukin <me@rlukin.ru>
2021-02-21 13:50:24 +03:00
baude cf2a551896 [CI:DOCS]basic networking guide
created a basic networking guide for podman that outlines the common
network setups for podman.

Fixes: #8874

Signed-off-by: baude <bbaude@redhat.com>
2021-02-18 13:21:33 -06:00
Matthew Cengia 3d105015f6 typo
Signed-off-by: Matthew Cengia <mattcen@mattcen.com>
2021-02-03 21:22:30 +11:00
Daniel J Walsh d9ebbbfe5b
Switch references of /var/run -> /run
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>
2021-01-07 05:37:24 -05:00
Daniel J Walsh f62a356515
Remove varlink support from Podman
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2020-11-26 16:50:42 -05:00
Lucendio f8f2ce07d6 [tutorials:mac-win-client] Fix command ensuring sshd is enabled
`-s, --signal` requires a value and is probably not intended to be here

Signed-off-by: Lucendio <dev@lucend.io>
2020-11-24 17:07:58 +01:00
Daniel J Walsh d200801152
Cleanup tutorials
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>
2020-11-17 06:49:53 -05:00
Benjamin Porter ba8a71f9ce Add missing --now in systemctl start command
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>
2020-11-12 19:18:59 -07:00
JJ Asghar 1147bc7e7b Update README.md
Typo

Signed-off-by: JJ Asghar <jjasghar@gmail.com>
2020-11-02 16:22:52 -06:00
Daniel J Walsh 996fe49aa7
Update rootless_tutorial.md
add clarifications in persistently setting unprivileged ping permissions
Signed-off-by: fuzxi <opuspam@posteo.de>

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2020-10-01 09:13:39 -04:00
Ashley Cui 98ae84cc9e [CI:DOCS] Update remote tutorials
update remote tutorial
update mac/windows tutorial
move varlink tutorial

Signed-off-by: Ashley Cui <acui@redhat.com>
2020-09-08 17:30:54 -04:00
Lokesh Mandvekar 36b1ed0a26 [CI:DOCS] Include Go bindings tutorial
Include the Go bindings blog post as a tutorial

Signed-off-by: Lokesh Mandvekar <lsm5@fedoraproject.org>
2020-08-19 21:22:53 -04:00
OpenShift Merge Robot 288ebec6e7
Merge pull request #6909 from rhatdan/podman
Switch all references to github.com/containers/libpod -> podman
2020-07-28 10:12:55 -04:00
OpenShift Merge Robot 14f8085016
Merge pull request #7079 from rhatdan/tuturial
update configuration for rootless podman
2020-07-28 14:58:52 +02:00
Daniel J Walsh a5e37ad280
Switch all references to github.com/containers/libpod -> podman
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2020-07-28 08:23:45 -04:00
Melykuti 909f989c41 Corrects typo in the name of the Linux package shadow-utils.
Signed-off-by: Bence Mélykúti <bence.melykuti@gmail.com>
2020-07-27 21:17:30 +02:00
Daniel J Walsh 7d0a5fc0da
update configuration for rootless podman
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>
2020-07-25 05:41:31 -04:00
Daniel J Walsh 841eac0af6
Switch references from libpod.conf to containers.conf
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2020-07-20 15:09:54 -04:00
TomSweeneyRedHat bc1f5ef36e [CI:DOCS] update httpd location in tutorial
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>
2020-05-30 13:51:44 -04:00
TomSweeneyRedHat c79c69f275 [CI:DOCS] Tweak casing in rootless doc
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>
2020-05-26 10:55:34 -04:00
OpenShift Merge Robot b4cd54a2fa
Merge pull request #6309 from cortopy/nonroot_vol_docs
add section on rootless volumes in the docs
2020-05-24 06:37:30 -04:00
Juan Jimenez-Anca bf32a5c67d add section on rootless volumes
Signed-off-by: Juan Jimenez-Anca <cortopy@users.noreply.github.com>
2020-05-23 15:58:05 +01:00
Matthew Heon 9ceff66a7d Update Derivative API tutorial to reflect the HTTP API
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>
2020-05-20 17:35:24 -04:00
Sascha Grunert eebcd8ef14
Add image signing with GPG tutorial
Signed-off-by: Sascha Grunert <sgrunert@suse.com>
2020-03-23 11:46:29 +01:00
Valentin Rothberg 3c473681e3 rootles tutorial: remove systemd unit example
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>
2020-03-09 13:39:56 +01:00
Leonardo Rochael Almeida 9abfc32e05 Enhance fuse-overlayfs instructions.
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>
2020-02-13 12:58:05 -03:00
Jhon Honce bf097c9e21 Update remote client bridge documentation.
* Add PODMAN_VARLINK_BRIDGE examples.

Signed-off-by: Jhon Honce <jhonce@redhat.com>
2020-01-28 13:31:09 -07:00
Steven Gubler 92152a5b80 Markdown Formatting Fixes
Signed-off-by: Steven Gubler <stevegubler@protonmail.com>
2019-10-18 15:38:30 -06:00
TomSweeneyRedHat 5f932fa441 Add api link to tutorials
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>
2019-10-02 10:25:42 -04:00
Matthew Heon 76120ce638 Move derivitive doc so it won't be treated as a manpage
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>
2019-09-30 08:56:38 -04:00