Mirror of goauthentik/authentik@github.com - Open-source identity platform
Go to file
Jens Langhammer 760352202e admin: fix get_form_class 2020-09-29 11:42:34 +02:00
.github new release: 0.10.7-stable 2020-09-26 19:26:12 +02:00
docs new release: 0.10.7-stable 2020-09-26 19:26:12 +02:00
e2e admin: fix get_form_class 2020-09-29 11:42:34 +02:00
helm new release: 0.10.7-stable 2020-09-26 19:26:12 +02:00
lifecycle lifecycle: update celery command for 5.0 2020-09-26 02:17:39 +02:00
passbook admin: fix get_form_class 2020-09-29 11:42:34 +02:00
proxy new release: 0.10.7-stable 2020-09-26 19:26:12 +02:00
scripts
.bumpversion.cfg new release: 0.10.7-stable 2020-09-26 19:26:12 +02:00
.coveragerc
.dockerignore
.editorconfig
.gitignore
.isort.cfg
.prospector.yaml
.pylintrc
Dockerfile root: fix apt autoremove call 2020-09-27 21:07:29 +02:00
LICENSE
Makefile ci: fix prospector call 2020-09-26 19:17:42 +02:00
Pipfile
Pipfile.lock build(deps-dev): bump django-debug-toolbar from 3.1 to 3.1.1 (#236) 2020-09-25 11:49:46 +02:00
README.md
SECURITY.md
azure-pipelines.yml ci: fix prospector call 2020-09-26 19:17:42 +02:00
docker-compose.yml root: don't set default log level in docker-compose 2020-09-27 19:36:44 +02:00
docker.env.yml
manage.py
mkdocs.yml docs: add outpost upgrading docs 2020-09-19 19:04:04 +02:00
pyrightconfig.json
pytest.ini policies: change .form() and .serializer() to properties, add tests 2020-09-29 10:32:58 +02:00
setup.cfg
static.Dockerfile
swagger.yaml lifecycle: update celery command for 5.0 2020-09-26 02:17:39 +02: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.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 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