Installing Perses in a container#
This section is explaining how you can install Perses using a container manager like Podman or Docker.
It assumes you have already installed and are familiar with either the Podman or the Docker commandline tooling.
Running container image#
Start the Perses container image using one of the following commands depending on your tooling choice:
The details in this command are that we give the container a referencable name (--name perses), automatically remove the container when it stops (--rm), map the local machine port 8080 to the container port 8080 (-p 127.0.0.1:8080:8080), and use the image version supported in these instructions (latest). Note: you can use any local port you have available, but you need to map to container port 8080.
The resulting console output should be something like:
time="2025-01-04T11:40:04Z" level=warning msg="encryption_key is not provided and therefore it will use a default one. For production instance you should provide the key."
___________
\___________/
___________ ______
\___________/ | ___ \
___________ | |_/ /__ _ __ ___ ___ ___
\___________/ | __/ _ \ '__/ __|/ _ \/ __|
___ | | | __/ | \__ \ __/\__ \
\___/ \_| \___|_| |___/\___||___/ [PERSES_VERSION]
__________________________________________________________
⇨ http server started on [::]:8080
Tags#
We are publishing a set of tags to match different requirements when running Perses in a container:
- Our images can run either on arm64 or on amd64 platform.
- We have two different types of image:
distroless
anddistroless-debug
. The first one is meant to be used in production as it doesn't contain anything excepting the Perses binaries. The second one contains a shell and should be used to debug any issue you might encounter with your container. - The tag
latest
is an alias for thedistroless
distribution and is erased with the latest release. - The tag
latest-debug
is an alias for thedistroless-debug
distribution and is erased with the latest release. - We are also providing an image for each commit created on the
main
branch. The tag created for each commit is following this pattern:main-<YYYY-MM-DD>-<short commit ID>-<distribution>
Examples:
- images built from the main branch:
persesdev/perses:main-2023-12-23-a2223483-distroless-debug
orpersesdev/perses:main-2023-12-23-a2223483-distroless
- latest Perses image:
persesdev/perses
orpersesdev/perses:latest-debug
- precise release image:
persesdev/perses:v0.50.0
,persesdev/perses:v0.50.0-debug
,persesdev/perses:v0.50.0-distroless
,persesdev/perses:v0.50.0-distroless-debug
- minor release image:
persesdev/perses:v0.50
,persesdev/perses:v0.50-debug
,persesdev/perses:v0.50-distroless
,persesdev/perses:v0.50-distroless-debug
Connect a browser (default)#
Open the Perses UI at http://localhost:8080.
You are presented with the home page, in light mode. For fun, you can optionally flip the switch in the top right corner to enable dark mode.
What's next?#
Explore the online Perses documentation