Portainer Templates logo

Portainer Templates

Ory Kratos (Oathkeeper) Ory Kratos (Oathkeeper)

Stack

Identity ManagementSecurity

Ory Kratos with Oathkeeper (ORY Oathkeeper is an Identity & Access Proxy (IAP) and Access Control Decision API that authorizes HTTP requests based on sets of Access Rules.)

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

kratos

Configuration

Env vars
SERVE_PUBLIC_BASE_URL=http://127.0.0.1:4455/.ory/kratos/public/

kratos-selfservice-ui-node

Configuration

Env vars
PORT=4435KRATOS_BROWSER_URL=http://127.0.0.1:4455/.ory/kratos/publicJWKS_URL=http://oathkeeper:4456/.well-known/jwks.jsonSECURITY_MODE=jwks

oathkeeper

Configuration

Image
oryd/oathkeeper:v0.40
Command
serve proxy -c "/etc/config/oathkeeper/oathkeeper.yml"
Ports
4455:44554456:4456
Volumes
/etc/config/oathkeeper : /portainer/Files/AppData/Config/oathkeeper
Env vars
LOG_LEVEL=debug
Restart
on-failure

Image details

Pulls: 91.1M
User: oryd
Created: Oct 18, 2017
Updated: 4 months ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Ory Kratos (Oathkeeper)

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Ory Kratos (Oathkeeper), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  kratos:
    environment:
      - SERVE_PUBLIC_BASE_URL=http://127.0.0.1:4455/.ory/kratos/public/

  kratos-selfservice-ui-node:
    environment:
      - PORT=4435
      - KRATOS_BROWSER_URL=http://127.0.0.1:4455/.ory/kratos/public
      - JWKS_URL=http://oathkeeper:4456/.well-known/jwks.json
      - SECURITY_MODE=jwks

  oathkeeper:
    image: oryd/oathkeeper:v0.40
    depends_on:
      - kratos
    ports:
      - 4455:4455
      - 4456:4456
    command:
      serve proxy -c "/etc/config/oathkeeper/oathkeeper.yml"
    environment:
      - LOG_LEVEL=debug
    restart: on-failure
    networks:
      - intranet
    volumes:
      - /portainer/Files/AppData/Config/oathkeeper:/etc/config/oathkeeper

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/ory-kratos-oathkeeper.yml up -d

More install options in our documentation.

Container Documentation

oathkeeper Documentation

A cloud native, security first firewall for your APIs. Integrates natively with ORY Hydra.

Serve Ory Kratos (Oathkeeper) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying ory-kratos-oathkeeper.example.com to http://oathkeeper:4455

Add this to your Caddyfile

ory-kratos-oathkeeper.example.com {
	reverse_proxy http://oathkeeper:4455
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:4455 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :4455
  • Stop the other service, or pick a different host port. In 4455:4455 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:4455. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Ory Kratos Oathkeeper can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 4455

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/oathkeeper

Image won't pull

Test the pull directly on the host: docker pull oryd/oathkeeper:v0.40

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Ory Kratos (Oathkeeper) is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • kratos
  • kratos-selfservice-ui-node
  • oathkeeper runs oryd/oathkeeper:v0.40, starts after kratos

Ports

A port is the door the app answers on. A mapping like 4455:4455 means it's reachable on port 4455 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 4455:4455
  • 4456:4456

Volumes

A volume is where Ory Kratos (Oathkeeper) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /etc/config/oathkeeper from /portainer/Files/AppData/Config/oathkeeper on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Ory Kratos (Oathkeeper) takes 6 of them, all with defaults you can leave alone or tweak:

  • SERVE_PUBLIC_BASE_URL, defaults to http://127.0.0.1:4455/.ory/kratos/public/
  • PORT, defaults to 4435
  • KRATOS_BROWSER_URL, defaults to http://127.0.0.1:4455/.ory/kratos/public
  • JWKS_URL, defaults to http://oathkeeper:4456/.well-known/jwks.json
  • SECURITY_MODE, defaults to jwks
  • LOG_LEVEL, defaults to debug

Restart policy

The restart policy here is on-failure, so Ory Kratos (Oathkeeper) only gets restarted when it exits with an error, not when it finishes cleanly or you stop it yourself. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like kratos) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Ory Kratos (Oathkeeper) up. Add the template list to Portainer once, then deploying Ory Kratos (Oathkeeper) is a click rather than a wall of config.