Skip to content

Latest commit

 

History

History
129 lines (116 loc) · 3.58 KB

docker.md

File metadata and controls

129 lines (116 loc) · 3.58 KB

Deploy with Docker images

Visit GitHub Container registry to see all available images and tags.

Image versions:

  • Every released version has its own tag, e.g. ghcr.io/pgrok/pgrokd:1.1.4.
  • The latest tag is an alias for the latest released version.
  • The insiders tag is the image version built from the latest main branch.

Standalone Docker container

  1. Pick a directory on the file system to store the configuration file (pgrokd.yml), e.g. /srv/pgrokd: 
    mkdir -p /srv/pgrokd
  2. Create the configuration file (/srv/pgrokd/pgrokd.yml): 
    external_url: "http://example.com"
web:
  port: 3320
proxy:
  port: 3000
  scheme: "http"
  domain: "example.com"
sshd:
  port: 2222

database:
  # Use "host.docker.internal" if your PostgreSQL is running locally on the same host.
  host: "localhost"
  port: 5432
  user: "REDACTED"
  password: "REDACTED"
  database: "pgrokd"

identity_provider:
  type: "oidc"
  display_name: "Google"
  issuer: "https://accounts.google.com"
  client_id: "REDACTED"
  client_secret: "REDACTED"
  field_mapping:
    identifier: "email"
    display_name: "name"
    email: "email"
# # The required domain name, "field_mapping.email" is required to set for this to work.
#  required_domain: "example.com"
  3. Start a Docker container.
    1. To only allow HTTP tunneling: 
      docker run \
  --detach \
  --restart always \
  --volume /srv/pgrokd:/var/opt/pgrokd \
  --publish 3320:3320 \
  --publish 3000:3000 \
  --publish 2222:2222 \
  --name pgrokd \
  ghcr.io/pgrok/pgrokd:latest
    2. If you want to allow tunneling raw TCP traffic (this only works on Linux, but expose port range in Docker is just too slow): 
      docker run \
  --detach \
  --restart always \
  --volume /srv/pgrokd:/var/opt/pgrokd \
  --network host \
  --name pgrokd \
  ghcr.io/pgrok/pgrokd:latest

Upgrade

docker stop pgrokd
docker rm pgrokd
docker run ...

Docker Compose

Note: The docker-compose.yml file lives under the repository root.

  1. Create the directory to store the configuration file (pgrokd.yml): 
    mkdir -p ./pgrokd
  2. Create the configuration file (./pgrokd/pgrokd.yml): 
    external_url: "http://example.com"
web:
  port: 3320
proxy:
  port: 3000
  scheme: "http"
  domain: "example.com"
sshd:
  port: 2222

database:
  # This connects to the "postgres" service.
  host: "postgres"
  port: 5432
  # Make sure to match the value of the environment variable "POSTGRES_USER"
  user: "REDACTED"
  # Make sure to match the value of the environment variable "POSTGRES_PASSWORD"
  password: "REDACTED"
  database: "pgrokd"

identity_provider:
  type: "oidc"
  display_name: "Google"
  issuer: "https://accounts.google.com"
  client_id: "REDACTED"
  client_secret: "REDACTED"
  field_mapping:
    identifier: "email"
    display_name: "name"
    email: "email"
# # The required domain name, "field_mapping.email" is required to set for this to work.
#  required_domain: "example.com"
  3. Start the cluster: 
    POSTGRES_USER=REDACTED \
POSTGRES_PASSWORD=REDACTED \
docker-compose up --detach