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 L 7be680cbe5
Migrate to Docusaurus (#329)
* docs: initial migration to docusaurus

* website: add custom font, update blurbs and icons

* website: update splash

* root: update links to docs

* flows: use .pbflow extension so docusaurus doesn't mangle the files

* e2e: workaround prospector

* Squashed commit of the following:

commit 1248585dca
Author: Jens Langhammer <jens.langhammer@beryju.org>
Date:   Sun Nov 15 20:46:53 2020 +0100

    e2e: attempt to fix prospector error again

commit 1319c480c4
Author: Jens Langhammer <jens.langhammer@beryju.org>
Date:   Sun Nov 15 20:41:35 2020 +0100

    ci: install previous python version for upgrade testing

* web: update accent colours and format

* website: format markdown files

* website: fix colours for text

* website: switch to temporary accent colour to improve readability

* flows: fix path for TestTransferDocs

* flows: fix formatting of tests
2020-11-15 22:42:02 +01:00
.github new release: 0.12.10-stable 2020-11-11 14:54:29 +01:00
e2e e2e: attempt to fix prospector error again 2020-11-15 20:46:53 +01:00
helm Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
lifecycle root: fix websockets not working correctly 2020-11-11 14:51:26 +01:00
passbook Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
proxy proxy: bump dependencies 2020-11-15 16:35:46 +01:00
scripts root: upgrade to python3.9 2020-11-15 16:15:01 +01:00
website Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
.bumpversion.cfg proxy: bump dependencies 2020-11-15 16:35:46 +01:00
.coveragerc ci: fix coverage combine for unittest and e2e 2020-09-14 09:52:43 +02:00
.dockerignore root: fix exclusion in dockerignore 2020-11-11 14:24:43 +01:00
.editorconfig repo cleanup, switch to new docker registry 2019-04-29 17:05:39 +02:00
.gitignore Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
.isort.cfg root: add process ID to logging output 2020-02-24 13:20:32 +01:00
.prospector.yaml root: upgrade to python3.9 2020-11-15 16:15:01 +01:00
.pylintrc e2e: attempt to fix prospector error again 2020-11-15 20:46:53 +01:00
Dockerfile root: upgrade to python3.9 2020-11-15 16:15:01 +01:00
LICENSE repo cleanup, switch to new docker registry 2019-04-29 17:05:39 +02:00
Makefile root: fix permission denied error for backups 2020-10-26 21:12:20 +01:00
Pipfile root: upgrade to python3.9 2020-11-15 16:15:01 +01:00
Pipfile.lock root: upgrade to python3.9 2020-11-15 16:15:01 +01:00
README.md Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
SECURITY.md docs: update to-012 2020-10-19 11:12:57 +02:00
azure-pipelines.yml ci: install previous python version for upgrade testing 2020-11-15 20:41:35 +01:00
docker-compose.yml new release: 0.12.10-stable 2020-11-11 14:54:29 +01:00
docker.env.yml e2e: add apply_default_data to load data from migrations after tables have been truncated 2020-06-07 19:31:16 +02:00
manage.py e2e: add OIDC Provider test against grafana, more formatting, minor bug fixes 2020-06-19 19:45:27 +02:00
pyproject.toml root: fix permission denied error for backups 2020-10-26 21:12:20 +01:00
pyrightconfig.json Proxy v2 (#189) 2020-09-03 00:04:12 +02:00
pytest.ini policies: change .form() and .serializer() to properties, add tests 2020-09-29 10:32:58 +02:00
setup.cfg OAuth Provider Rewrite (#182) 2020-08-19 10:32:44 +02:00
static.Dockerfile root: add missing libraries for static docker container 2020-11-15 16:17:25 +01:00
swagger.yaml */saml: fully migrate to xmlsec, remove signxml dependency 2020-11-15 15:20:56 +01:00

README.md

passbook logopassbook

CI Build status Tests Code Coverage Docker pulls Latest version LGTM Grade

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, see the documentation

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.8+ (3.9 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 the docker-compose file in scripts/docker-compose.yml.

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

Security

See SECURITY.md