Docker Guide

Back

This guide is for using Pocket Relay within a Docker containerized environment. Refer to the Executable Guide if you aren’t intending to run your Pocket Relay server within Docker

Docker Image

The prebuilt image for compiling and running the Pocket Relay server is available on Docker Hub under the following name:

jacobtread/pocket-relay:latest

There is a Dockerfile included in the Server source repository if you would like to manually build the Docker image

Docker Compose

If you would like to use Docker Compose to run your server you can create a docker-compose.yml file with the following contents:

version: "3"
services:
  pocket-relay:
    container_name: pocket-relay
    restart: unless-stopped
    ports:
      # Server port
      - 80:80/tcp
    image: jacobtread/pocket-relay:latest

Docker Run

If you would like to use just the docker run command you can use the following command to start a new Pocket Relay container and expose the nessicary port

docker run -d -p 80:80/tcp jacobtread/pocket-relay:latest

Updating

When a new version of Pocket Relay is released you will need to update the image using

docker pull jacobtread/pocket-relay:latest