authentik fork
This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Jens Langhammer eeb62f543f docs: fix wrong paths in nav section 2020-06-05 17:31:41 +02:00
.github docs: simplify index, update, add screenshots 2020-06-05 12:51:28 +02:00
docker docker: fix import order on wait_for_db 2020-05-16 22:56:14 +02:00
docs docs: add example for login flow 2020-06-05 17:29:08 +02:00
gatekeeper providers/appgw(major): rewrite to use oauth2_proxy 2019-11-11 18:13:46 +01:00
helm helm: fully remove domain, add log_level 2020-05-20 12:16:56 +02:00
passbook docs: add example for login flow 2020-06-05 17:29:08 +02:00
scripts admin: add generic tests 2020-05-19 20:59:43 +02:00
.bumpversion.cfg new release: 0.8.15-beta 2020-04-10 21:57:20 +02:00
.coveragerc policy(minor): add unittests for policy engine 2019-10-14 16:08:24 +02:00
.dockerignore ui: update static docker image to download NPM modules 2020-02-21 15:33:54 +01:00
.editorconfig repo cleanup, switch to new docker registry 2019-04-29 17:05:39 +02:00
.fossa.yml root: add fossa 2020-05-08 21:08:36 +02:00
.gitignore root(minor): add script to run coverage 2019-12-02 16:43:50 +01:00
.isort.cfg root: add process ID to logging output 2020-02-24 13:20:32 +01:00
.prospector.yaml root: fix pylint not correctly ignoring migrations 2020-05-27 11:15:10 +02:00
.pylintrc root: fix pylint not correctly ignoring migrations 2020-05-27 11:15:10 +02:00
Dockerfile root: rewrite bootstrap in python, remove management command 2020-05-16 22:46:17 +02:00
LICENSE repo cleanup, switch to new docker registry 2019-04-29 17:05:39 +02:00
Pipfile policies/expression: migrate to raw python instead of jinja2 (#49) 2020-06-05 12:00:27 +02:00
Pipfile.lock policies/expression: migrate to raw python instead of jinja2 (#49) 2020-06-05 12:00:27 +02:00
README.md Merge branch 'master' into docs-flows 2020-06-05 12:51:10 +02:00
SECURITY.md root: update readme 2020-05-27 17:26:35 +02:00
docker-compose.yml root: update readme 2020-05-27 17:26:35 +02:00
manage.py admin: add flows 2020-05-08 18:45:53 +02:00
mkdocs.yml docs: fix wrong paths in nav section 2020-06-05 17:31:41 +02:00
pyrightconfig.json stages/password: fix possibility of password in logs 2020-05-09 20:53:32 +02:00
setup.cfg core: cleanup 2018-12-09 21:07:38 +01:00
static.Dockerfile providers/oidc: fix skip_authorization not being synced to oidc_client 2020-03-02 17:40:38 +01:00
swagger.yaml stages/identification: minor UI fixes 2020-06-05 17:02:50 +02:00

README.md

passbook logopassbook

What is passbook?

passbook is an open-source Identity Provider focused on flexibility and versatility. You can use passbook in an existing environment to add support for new protocols. passbook is also a great solution for implementing signup/recovery/etc in your application, so you don't have to deal with it.

Installation

For small/test setups it is recommended to use docker-compose.

wget https://raw.githubusercontent.com/BeryJu/passbook/master/docker-compose.yml
# Optionally enable Error-reporting
# export PASSBOOK_ERROR_REPORTING=true
# Optionally deploy a different version
# export PASSBOOK_TAG=0.8.15-beta
# If this is a productive installation, set a different PostgreSQL Password
# export PG_PASS=$(pwgen 40 1)
docker-compose pull
docker-compose up -d
docker-compose exec server ./manage.py migrate

For bigger setups, there is a Helm Chart in the helm/ directory. This is documented here

Screenshots

Development

To develop on passbook, you need a system with Python 3.7+ (3.8 is recommended). passbook uses pipenv for managing dependencies.

To get started, run

python3 -m pip install pipenv
git clone https://github.com/BeryJu/passbook.git
cd passbook
pipenv shell
pipenv sync -d

Since passbook uses PostgreSQL-specific fields, you also need a local PostgreSQL instance to develop. passbook also uses redis for caching and message queueing. For these databases you can use Postgres.app and Redis.app on macOS or use it via docker-comppose:

version: '3.7'

services:
  postgresql:
    container_name: postgres
    image: postgres:11
    volumes:
    - db-data:/var/lib/postgresql/data
    ports:
    - 127.0.0.1:5432:5432
    restart: always
  redis:
    container_name: redis
    image: redis
    ports:
    - 127.0.0.1:6379:6379
    restart: always

volumes:
  db-data:
    driver: local

To tell passbook about these databases, create a file in the project root called local.env.yml with the following contents:

debug: true
postgresql:
  user: postgres

log_level: debug
error_reporting: false

Security

See SECURITY.md