#Deploying with Docker

Docker simplifies the installation of Palpo, and it is recommended to deploy Palpo using Docker. If Docker is not yet installed on your computer, you can download the installation file for your operating system from the Docker website.

#Using Preconfigured Templates

First, download the palpo.toml configuration file. The palpo.toml file contains only essential configuration items. Ensure you modify the values to the correct ones before starting the server.

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

• compose.yml

  This configuration includes only the Postgres database and the Palpo server program. You need to modify the POSTGRES_PASSWORD in the configuration before starting.

• compose.with-caddy.yml

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

  docker network create caddy

• compose.with-traefik.yml

  If you do not have a traefik instance set up, use this configuration. It adds Traefik as a reverse proxy server.

• compose.for-traefik.yml

  If you already have a traefik instance set up, use this configuration. It adds an existing Traefik as a reverse proxy server.

Note: Do not 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, then run the following command to start the server:

docker compose up -d

Note: You may encounter the error Error response from daemon: Get "https://registry-1.docker.io/v2/": unauthorized: incorrect username or password. Follow these 2 steps to resolve it:

Step 1: Generate a GitHub Token Visit GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic) Check the read:packages permission.

Step 2: Login to ghcr.io

export CR_PAT=your_github_token
echo $CR_PAT | docker login ghcr.io -u your_github_username --password-stdin

and then to compose up again:

docker compose up -d

Open your browser and enter the service address you set. If everything is configured correctly, the page will display: Hello Palpo!.

Congratulations, the server is now working properly. You can choose any Matrix client you prefer (e.g., Element, Cinny, Robrix) to connect to the current server.

You can find more client lists on the Matrix website.

#Using Images Directly

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

Registry	Image	Size	Remarks
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 \
    -v palpo.toml:/var/palpo/palpo.toml \
    -v ./data/media:/var/palpo/media \
    --name palpo palpo/palpo:latest

Alternatively, you can use docker compose.

The -d flag runs the container in detached mode. You can provide an optional palpo.toml configuration file, and an example configuration can be found here.

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

{/* 本行由工具自动生成,原文哈希值:0eff992f80c99c7b28dfeb1f555f6dd4 */}