Portainer Templates logo

Portainer Templates

LiveKit Agents

Stack

Voice Realtime

A voice AI agent worker on the LiveKit Agents framework: it joins LiveKit rooms and converses - Deepgram for ears, ElevenLabs for voice, any OpenAI-compatible LLM for the brain (the catalogue's litellm gateway slots in via

Configuration

Type
Compose
Platform
linux
Env vars
LIVEKIT_URL=${LIVEKIT_URL:-ws://livekit:5000}LIVEKIT_API_KEY=${LIVEKIT_API_KEY}LIVEKIT_API_SECRET=${LIVEKIT_API_SECRET}ELEVEN_API_KEY=${ELEVEN_API_KEY:-}DEEPGRAM_API_KEY=${DEEPGRAM_API_KEY:-}OPENAI_API_KEY=${OPENAI_API_KEY:-}
Restart
unless-stopped
Build
https://github.com/livekit-examples/agent-starter-python.git
Source
Repo

Template by deployable-sh·Source

Report issue

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select LiveKit Agents, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: livekit-agents

services:
  agent:
    build:
      context: https://github.com/livekit-examples/agent-starter-python.git
    restart: unless-stopped
    environment:
      LIVEKIT_URL: ${LIVEKIT_URL:-ws://livekit:5000}
      LIVEKIT_API_KEY: ${LIVEKIT_API_KEY}
      LIVEKIT_API_SECRET: ${LIVEKIT_API_SECRET}
      ELEVEN_API_KEY: ${ELEVEN_API_KEY:-}
      DEEPGRAM_API_KEY: ${DEEPGRAM_API_KEY:-}
      OPENAI_API_KEY: ${OPENAI_API_KEY:-}

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f livekit-agents/compose.yaml up -d

More install options in our documentation.

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

LiveKit Agents is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. LiveKit Agents takes 6 of them, all with defaults you can leave alone or tweak:

  • LIVEKIT_URL, defaults to ws://livekit:5000. Your LiveKit server (in-project: ws://livekit:5000) or LiveKit Cloud.
  • LIVEKIT_API_KEY, pulled from your own environment
  • LIVEKIT_API_SECRET, pulled from your own environment
  • ELEVEN_API_KEY, pulled from your own environment. Provider keys (use what your agent's pipeline needs; billed to you).
  • DEEPGRAM_API_KEY, pulled from your own environment
  • OPENAI_API_KEY, pulled from your own environment

Restart policy

The restart policy here is unless-stopped, so Docker restarts LiveKit Agents after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so LiveKit Agents sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container agent. That's what you'll spot in the containers list and use in commands like docker logs agent.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set LiveKit Agents up. Add the template list to Portainer once, then deploying LiveKit Agents is a click rather than a wall of config.