#Installing with Docker

Docker simplifies Palpo installation and is recommended. If you don't have Docker installed on your computer, you can download the installation file for your system from the Docker website.

#Using a Prefab Configuration Template

First, download the palpo.toml configuration files. palpo.toml only contains the necessary configuration items. Please make sure to modify them to the correct values before starting the server.

Then, download the following Docker Compose configuration files as needed and place them in the same folder.

• compose.yml

This only configures the Postgres database and the Palpo server. You will need to modify POSTGRES_PASSWORD in the configuration file before starting the server.

• compose.with-caddy.yml

If you want an out-of-the-box caddy-docker-proxy setup, use this configuration. This adds Caddy as a reverse proxy server. Replace all example.com placeholders with your own domain name. You will also need to create the caddy network before starting:

docker network create caddy

• compose.with-traefik.yml

If you don't have a traefik instance set up, use this configuration. This adds Traefik as a reverse proxy server.

• compose.for-traefik.yml

If you already have a Traefik instance set up, use this configuration. This configuration adds the use of the existing Traefik instance as a reverse proxy server.

Note: Don't forget to modify and adjust the compose.yml and palpo.toml files according to your needs.

Rename the downloaded compose.*.yml file to compose.yml and run the following command to start the server:

docker compose up -d

Open a browser and enter the service address you set. If everything is set up correctly, the page "Hello Palpo!" should display.

Congratulations, your server is now working. You can use any Matrix client of your choice (e.g., Element, Cinny, Robrix) to connect to the current server.

You can find a list of more clients on the Matrix website.

#Using an Image Directly

If you want to run Palpo directly from its OCI image, you can find it in the following registry.

Registry	Image	Size	Notes
GitHub Registry	ghcr.io/palpo-im/palpo:latest		Stable, latest tagged image.
Docker Hub	docker.io/ghcr.io/palpo-im/palpo:latest		Stable, latest tagged image.

Once you have the image, you can simply run the following command:

docker run -d -p 8448:8448 -p 8008:8008 \
- palpo.toml:/var/palpo/palpo.toml \
-v data/media:/var/palpo/media \
--name palpo

Or you can use docker compose.

The -d flag runs the container in detached mode. You can provide an optional palpo.toml configuration file; a sample configuration can be found here.

If you only want to test Palpo briefly, you can use the --rm flag, which will clean up all container-related content after you stop it.

#Voice Communication

See the TURN page.