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 9fb1ac98ec
Backup/Restore (#256)
* lifecycle: move s3 backup settings to s3 name

* providers/oauth2: fix for alerting for missing certificatekeypair

* lifecycle: add backup commands

see #252

* lifecycle: install postgres-client for 11 and 12

* root: migrate to DBBACKUP_STORAGE_OPTIONS, add region setting

* lifecycle: auto-clean last backups

* helm: add s3 region parameter, add cronjob for backups

* docs: add backup docs

* root: remove backup scheduled task for now
2020-10-03 20:36:36 +02:00
.github new release: 0.10.9-stable 2020-10-01 10:24:16 +02:00
docs Backup/Restore (#256) 2020-10-03 20:36:36 +02:00
e2e e2e: fix invalid proxy image being pulled 2020-10-02 10:30:56 +02:00
helm Backup/Restore (#256) 2020-10-03 20:36:36 +02:00
lifecycle Backup/Restore (#256) 2020-10-03 20:36:36 +02:00
passbook Backup/Restore (#256) 2020-10-03 20:36:36 +02:00
proxy new release: 0.10.9-stable 2020-10-01 10:24:16 +02:00
scripts core: fix path to default icon 2020-09-13 20:47:17 +02:00
.bumpversion.cfg new release: 0.10.9-stable 2020-10-01 10:24:16 +02:00
.coveragerc ci: fix coverage combine for unittest and e2e 2020-09-14 09:52:43 +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
.gitignore e2e: Add denied tests for oauth and oidc provider 2020-07-02 21:55:02 +02: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: increase limit of max-attributes in pylint 2020-09-19 13:40:23 +02:00
Dockerfile Backup/Restore (#256) 2020-10-03 20:36:36 +02:00
LICENSE repo cleanup, switch to new docker registry 2019-04-29 17:05:39 +02:00
Makefile root: lock pyright version 2020-10-03 15:34:53 +02:00
Pipfile root: update black version 2020-09-30 16:39:15 +02:00
Pipfile.lock build(deps): bump django from 3.1.1 to 3.1.2 (#255) 2020-10-02 09:50:18 +02:00
README.md readme: link to install instructions from docs 2020-09-15 17:17:29 +02:00
SECURITY.md stages/password: improve labelling of LDAP backend 2020-09-17 15:54:48 +02:00
azure-pipelines.yml root: lock pyright version 2020-10-03 15:34:53 +02:00
docker-compose.yml Backup/Restore (#256) 2020-10-03 20:36:36 +02: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
mkdocs.yml Backup/Restore (#256) 2020-10-03 20:36:36 +02: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 Proxy v2 (#189) 2020-09-03 00:04:12 +02:00
swagger.yaml core: move name field to base Provider 2020-10-03 20:05:16 +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