LiveKit Server Ansible role

This is an Ansible role which installs LiveKit Server to run as a Docker container wrapped in a systemd service.

This role implicitly depends on:

• com.devture.ansible.role.playbook_help
• com.devture.ansible.role.systemd_docker_base

Check defaults/main.yml for the full list of supported options. Refer to this page for details about setting up the service with this role.

💡 For an Ansible playbook which integrates this role and makes it easier to use, see the Mother-of-All-Self-Hosting Ansible playbook.

Development

pre-commit

You can optionally install a Git pre-commit hook (via mise + prek) that runs formatting and linting checks before each commit. See .pre-commit-config.yaml for which hooks are to be executed.

To install the hook, run the just command below:

just prek-install-git-pre-commit-hook

Molecule

This role supports Molecule, an Ansible testing framework designed for developing and testing Ansible collections, playbooks, and roles.

Refer to this page for details about how to utilize it.

Releases

Tags are created on the GitHub workflow by .github/workflows/autotag.yml, which asks bin/compute-next-tag.sh what the commit on main should be released as. The answer comes from the version pinned in defaults/main.yml and from the tags that already exist, so a commit that only touches documentation or CI is not released at all, and any change to the role itself is — without waiting for a dependency bump to carry it along.

bin/test-compute-next-tag.sh exercises that script against throwaway repositories, and runs as a prek hook.