Portainer Templates logo

Portainer Templates

Casdoor Casdoor

Stack

Security

Identity and single sign-on server, so your other apps can share one login over OAuth 2, OIDC, SAML or CAS, with a web UI for users, organisations, apps, MFA and social logins. Source: https://github.com/casdoor/casdoor

Source details

Stars: 14.7k
Forks: 2k
Language: Go
License: Apache-2.0
Updated: 2 hours ago
Website: casdoor.ai/

Configuration

Type
Compose
Platform
linux
Env vars
CASDOOR_ADMIN_PASSWORD=''CASDOOR_DB_PASSWORD=''CASDOOR_PORT=8800
Restart
unless-stopped
Source

Notes

Set the admin password and database password before you deploy, since the stack won't start without them. Then open http://<your-host>:8800 (or whichever port you picked) and log in as admin with that password. It's only read on the very first start, so change it later from the admin's own account page, not here. Everyone in the built-in organisation is an admin, so put your users in an organisation of their own, and give each app that should log in through Casdoor an application with its redirect URL. Apps find it at /.well-known/openid-configuration, and Casdoor names itself after whatever address they reach it on, so keep that the same everywhere. An update signs everyone out of Casdoor itself, as its sessions live in the container. Logos and pictures on its pages load from cdn.casbin.org. Users, apps and settings live in Postgres, in the postgres-data volume. Docs: casdoor.org/docs

Services

casdoor

Configuration

Image
casbin/casdoor:4
Ports
${CASDOOR_PORT:-8800}:8000
Env vars
driverName=postgresdataSourceName=user=casdoor password=${CASDOOR_DB_PASSWORD:?Set a database password} host=postgres port=5432 sslmode=disable dbname=casdoordbName=casdoorinitAdminPassword=${CASDOOR_ADMIN_PASSWORD:?Set the admin password}
Restart
unless-stopped

Image details

Pulls: 1.9M
User: hsluoyz
Created: Aug 11, 2021
Updated: 1 day ago
Status: active

postgres

Configuration

Image
postgres:17-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=casdoorPOSTGRES_USER=casdoorPOSTGRES_PASSWORD=${CASDOOR_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 12.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 14 hours ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Casdoor

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 Casdoor, 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:
  casdoor:
    image: casbin/casdoor:4
    restart: unless-stopped
    ports:
      - "${CASDOOR_PORT:-8800}:8000"
    environment:
      driverName: postgres
      dataSourceName: user=casdoor password=${CASDOOR_DB_PASSWORD:?Set a database password} host=postgres port=5432 sslmode=disable dbname=casdoor
      dbName: casdoor
      initAdminPassword: ${CASDOOR_ADMIN_PASSWORD:?Set the admin password}
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      POSTGRES_DB: casdoor
      POSTGRES_USER: casdoor
      POSTGRES_PASSWORD: ${CASDOOR_DB_PASSWORD:?Set a database password}
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U casdoor -d casdoor"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  postgres-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/casdoor/compose.yml up -d

More install options in our documentation, or see casdoor/casdoor for app-specific guidance.

Container Documentation

postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

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.

Image won't pull

Test the pull directly on the host: docker pull casbin/casdoor:4

  • "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.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

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

Casdoor is a Compose stack, a set of containers (2 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 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • casdoor runs casbin/casdoor:4, starts after postgres
  • postgres runs postgres:17-alpine

Volumes

A volume is where Casdoor 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:

  • /var/lib/postgresql/data kept in the postgres-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Casdoor takes 7 of them, and 2 need a value before it'll start properly:

  • driverName, defaults to postgres
  • dataSourceName, defaults to user=casdoor password= host=postgres port=5432 sslmode=disable dbname=casdoor
  • dbName, defaults to casdoor
  • initAdminPassword, needs a value
  • POSTGRES_DB, defaults to casdoor
  • POSTGRES_USER, defaults to casdoor
  • POSTGRES_PASSWORD, needs a value

Restart policy

The restart policy here is unless-stopped, so Docker restarts Casdoor after a crash or reboot, but leaves it off when you stop it on purpose. 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 casdoor) 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.

Open source license

Casdoor is open source, released under the Apache-2.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

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