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.

Sign up for GitHub

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

Quadlet quickstart #92

Open
wants to merge 1 commit into
base: stable
Choose a base branch
from
+40 −0
Open

Quadlet quickstart #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 40 additions & 0 deletions docs/modules/user/pages/quickstart.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,46 @@ services:
restart: unless-stopped
....
Podman quadlet:
[source,ini]
....
[Unit]
Description=Podman Wolf Gamestreaming
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This unit implies you're using a system wide podman service. This will work if you have podman.socket active when you run this unit, but it would be best if you added the dependency explicitly.

[Unit]
Description=Podman Wolf Gamestreaming
Requires=podman.service
After=podman.service

[Service]
TimeoutStartSec=900
ExecStartPre=-/usr/bin/mkdir /tmp/sockets
ExecStartPre=-/usr/bin/podman rm --force WolfPulseAudio
Restart=on-failure
RestartSec=5
StartLimitBurst=5
[Container]
AutoUpdate=registry
ContainerName=%N
HostName=%N
Image=ghcr.io/games-on-whales/wolf:stable
AddCapability=CAP_SYS_PTRACE
AddCapability=CAP_NET_ADMIN
Network=host
SecurityLabelDisable=true
PodmanArgs=--ipc=host --device-cgroup-rule "c 13:* rmw"
AddDevice=/dev/dri
AddDevice=/dev/uinput
AddDevice=/dev/uhid
Environment=HOST_APPS_STATE_FOLDER=/etc/wolf
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving env var definitions to a separate file and using EnvironmentFile here would allow for updating env variables without having to run systemctl daemon-reload for the env updates to be picked up on service restart.

An example of using EnvironmentFile can be found here: https://www.flatcar.org/docs/latest/setup/systemd/environment-variables/#environmentfile-directive

I'm currently working around some permissions issues related to running on Bazzite, but here are the working configs I'm using: https://github.com/detiber/beardy-os/pull/1/files

I'm going to continue tweaking on things in that PR while I re-scope the permissions back down

Environment=GST_DEBUG=2
Comment on lines +89 to +90
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any reason why you manually specified those? It shouldn't be required since it's the same as the defaults

wolf/docker/wolf.Dockerfile

Lines 115 to 116 in e10d00b

HOST_APPS_STATE_FOLDER=/etc/wolf \
GST_DEBUG=2 \

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The original quadlet file that was posted on discord set a bunch more environment variables which I removed.
Apparently I forgot to remove the GST_DEBUG line.
The HOST_APPS_STATE_FOLDER I kept because both the docker and docker-compose blocks set that variable as well.

If you want I can remove it from all of them...

Volume=/dev/input:/dev/input:ro
Volume=/run/udev:/run/udev:ro
Volume=/tmp/sockets:/tmp/sockets:rw
Volume=/run/podman/podman.sock:/var/run/docker.sock:ro
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The podman.socket unit uses %t/podman/podman.sock.
The snippet here should do the same, since distros might put it in /var/run instead.

Volume=/etc/wolf:/etc/wolf
[Install]
WantedBy=multi-user.target
....
--
Nvidia (Container Toolkit)::
+
Expand Down