Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: stabilize podman support for devel #454

Merged
merged 2 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ jobs:
- run: pip install poetry
- name: Patch $PATH
run: echo "$HOME/.local/bin" >> $GITHUB_PATH
- run: poetry install
- run: poetry install --no-root
# Precreate shared networks to avoid race conditions
- run: docker network create inverseproxy_shared
- run: docker network create globalwhitelist_shared
Expand Down
11 changes: 2 additions & 9 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,11 +356,7 @@ default.

## How to use with podman?

Podman 3.4+ support is experimental.

⚠ You will not have [network isolation](daily-usage.md#network-isolation) until podman
rootless networks are fully supported. See
https://github.com/containers/podman/issues/10672 for progress on that subject.
Podman 4+ is supported for development, provided you follow these instructions.

Example usage:

Expand All @@ -375,19 +371,16 @@ systemctl enable --user --now podman.socket
export DOCKER_HOST=unix:///run/user/$(id -u)/podman/podman.sock
# Instruct git-aggregator to use inner UID and GID 0, which podman will map to your user
export DOODBA_GITAGGREGATE_UID=0 DOODBA_GITAGGREGATE_GID=0 DOODBA_UMASK=22
# Disable network isolation
export DOODBA_NETWORK_INTERNAL=false
```

Once all that is done, continue with normal wokflow on that terminal.
Once all that is done, continue with normal workflow on that terminal.

Add those exports to your bash profile to avoid repeating them for each terminal. If you
use `fish`, it's easier:

```fish
# Fish-only syntax to save all those exports permanently
set --universal --export DOCKER_HOST unix:///run/user/(id -u)/podman/podman.sock
set --universal --export DOODBA_NETWORK_INTERNAL false
set --universal --export DOODBA_GITAGGREGATE_UID 0
set --universal --export DOODBA_GITAGGREGATE_GID 0
set --universal --export DOODBA_UMASK 22
Expand Down
Loading