authentik/mkdocs.yml

site_name: passbook Docs
site_url: https://passbook.beryju.org/
copyright: "Copyright &copy; 2019 - 2020 BeryJu.org"

nav:
  - Home: index.md
  - Terminology: terminology.md
  - Installation:
    - docker-compose: installation/docker-compose.md
    - Kubernetes: installation/kubernetes.md
  - Flows:
      Overview: flow/flows.md
      Examples: flow/examples/examples.md
  - Stages:
      - Captcha Stage: flow/stages/captcha/index.md
      - Dummy Stage: flow/stages/dummy/index.md
      - Email Stage: flow/stages/email/index.md
      - Identification Stage: flow/stages/identification/index.md
      - Invitation Stage: flow/stages/invitation/index.md
      - OTP Stage: flow/stages/otp/index.md
      - Password Stage: flow/stages/password/index.md
      - Prompt Stage: flow/stages/prompt/index.md
      - Prompt Stage Validation: flow/stages/prompt/validation.md
      - User Delete Stage: flow/stages/user_delete.md
      - User Login Stage: flow/stages/user_login.md
      - User Logout Stage: flow/stages/user_logout.md
      - User Write Stage: flow/stages/user_write.md
  - Sources: sources.md
  - Providers:
    - OAuth2: providers/oauth2.md
    - SAML: providers/saml.md
    - Proxy: providers/proxy.md
  - Outposts:
    - Overview: outposts/outposts.md
    - Upgrading: outposts/upgrading.md
    - Deploy on docker-compose: outposts/deploy-docker-compose.md
    - Deploy on Kubernetes: outposts/deploy-kubernetes.md
  - Expressions:
    - Overview: expressions/index.md
    - Reference:
      - User Object: expressions/reference/user-object.md
  - Property Mappings:
    - Overview: property-mappings/index.md
    - Expressions: property-mappings/expression.md
  - Policies:
    - Overview: policies/index.md
    - Expression: policies/expression.md
  - Integrations:
    - as Provider:
        - Amazon Web Services: integrations/services/aws/index.md
        - GitLab: integrations/services/gitlab/index.md
        - Rancher: integrations/services/rancher/index.md
        - Harbor: integrations/services/harbor/index.md
        - Sentry: integrations/services/sentry/index.md
        - Ansible Tower/AWX: integrations/services/tower-awx/index.md
        - VMware vCenter: integrations/services/vmware-vcenter/index.md
        - Ubuntu Landscape: integrations/services/ubuntu-landscape/index.md
        - Sonarr: integrations/services/sonarr/index.md
        - Tautulli: integrations/services/tautulli/index.md
  - Maintenance:
    - Backups: maintenance/backups/index.md
  - Upgrading:
    - to 0.9: upgrading/to-0.9.md
    - to 0.10: upgrading/to-0.10.md
  - Troubleshooting:
    - Access problems: troubleshooting/access.md

repo_name: "BeryJu/passbook"
repo_url: https://github.com/BeryJu/passbook
theme:
  name: material
  logo: images/logo.svg
  favicon: images/logo.svg
  palette:
    scheme: slate
    primary: white

markdown_extensions:
  - toc:
      permalink: "¶"
  - admonition
  - codehilite
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - attr_list

plugins:
  - search
docs: add initial structure, add docs for policies and factors 2019-12-09 20:00:45 +00:00			`site_name: passbook Docs`
root: update docs URL 2020-06-05 18:18:26 +00:00			`site_url: https://passbook.beryju.org/`
docs: add some more info to mkdocs 2019-12-12 08:55:10 +00:00			`copyright: "Copyright © 2019 - 2020 BeryJu.org"`

docs: add initial structure, add docs for policies and factors 2019-12-09 20:00:45 +00:00			`nav:`
docs: add providers and sources 2019-12-12 17:00:23 +00:00			`- Home: index.md`
Merge branch 'master' into docs-flows # Conflicts: # mkdocs.yml 2020-06-05 10:51:10 +00:00			`- Terminology: terminology.md`
docs: add providers and sources 2019-12-12 17:00:23 +00:00			`- Installation:`
docs: add upgrade page 2020-05-16 21:46:25 +00:00			`- docker-compose: installation/docker-compose.md`
			`- Kubernetes: installation/kubernetes.md`
docs: add example for login flow 2020-06-05 15:29:08 +00:00			`- Flows:`
			`Overview: flow/flows.md`
docs: add example flows closes #36 2020-09-08 21:18:42 +00:00			`Examples: flow/examples/examples.md`
docs: add docs for flows, start docs for stages 2020-05-30 20:36:01 +00:00			`- Stages:`
docs: fix wrong paths in nav section 2020-06-05 15:31:41 +00:00			`- Captcha Stage: flow/stages/captcha/index.md`
			`- Dummy Stage: flow/stages/dummy/index.md`
*: make email naming consistent 2020-06-18 17:35:54 +00:00			`- Email Stage: flow/stages/email/index.md`
docs: fix wrong paths in nav section 2020-06-05 15:31:41 +00:00			`- Identification Stage: flow/stages/identification/index.md`
			`- Invitation Stage: flow/stages/invitation/index.md`
			`- OTP Stage: flow/stages/otp/index.md`
			`- Password Stage: flow/stages/password/index.md`
			`- Prompt Stage: flow/stages/prompt/index.md`
docs: add docs for flows and all stages 2020-06-02 21:52:02 +00:00			`- Prompt Stage Validation: flow/stages/prompt/validation.md`
docs: add docs for flows, start docs for stages 2020-05-30 20:36:01 +00:00			`- User Delete Stage: flow/stages/user_delete.md`
			`- User Login Stage: flow/stages/user_login.md`
			`- User Logout Stage: flow/stages/user_logout.md`
			`- User Write Stage: flow/stages/user_write.md`
docs: add providers and sources 2019-12-12 17:00:23 +00:00			`- Sources: sources.md`
docs: improve documentation for providers 2020-09-09 17:14:12 +00:00			`- Providers:`
			`- OAuth2: providers/oauth2.md`
			`- SAML: providers/saml.md`
docs: add docs for proxy provider 2020-09-09 17:21:36 +00:00			`- Proxy: providers/proxy.md`
docs: add outpost deployment docs, link in outposts list 2020-09-13 20:20:17 +00:00			`- Outposts:`
			`- Overview: outposts/outposts.md`
docs: add outpost upgrading docs 2020-09-19 17:04:04 +00:00			`- Upgrading: outposts/upgrading.md`
docs: add outpost deployment docs, link in outposts list 2020-09-13 20:20:17 +00:00			`- Deploy on docker-compose: outposts/deploy-docker-compose.md`
			`- Deploy on Kubernetes: outposts/deploy-kubernetes.md`
policies/expression: migrate to raw python instead of jinja2 (#49) * policies/expression: migrate to raw python instead of jinja2 * lib/expression: create base evaluator, custom subclass for policies * core: rewrite propertymappings to use python * providers/saml: update to new PropertyMappings * sources/ldap: update to new PropertyMappings * docs: update docs for new propertymappings * root: remove jinja2 * root: re-add jinja to lock file as its implicitly required 2020-06-05 10:00:27 +00:00			`- Expressions:`
			`- Overview: expressions/index.md`
			`- Reference:`
			`- User Object: expressions/reference/user-object.md`
docs: update policy types, add docs for expression policies 2020-02-19 09:21:28 +00:00			`- Property Mappings:`
docs: add upgrade page 2020-05-16 21:46:25 +00:00			`- Overview: property-mappings/index.md`
policies/expression: migrate to raw python instead of jinja2 (#49) * policies/expression: migrate to raw python instead of jinja2 * lib/expression: create base evaluator, custom subclass for policies * core: rewrite propertymappings to use python * providers/saml: update to new PropertyMappings * sources/ldap: update to new PropertyMappings * docs: update docs for new propertymappings * root: remove jinja2 * root: re-add jinja to lock file as its implicitly required 2020-06-05 10:00:27 +00:00			`- Expressions: property-mappings/expression.md`
docs: update policy types, add docs for expression policies 2020-02-19 09:21:28 +00:00			`- Policies:`
docs: add upgrade page 2020-05-16 21:46:25 +00:00			`- Overview: policies/index.md`
policies/expression: migrate to raw python instead of jinja2 (#49) * policies/expression: migrate to raw python instead of jinja2 * lib/expression: create base evaluator, custom subclass for policies * core: rewrite propertymappings to use python * providers/saml: update to new PropertyMappings * sources/ldap: update to new PropertyMappings * docs: update docs for new propertymappings * root: remove jinja2 * root: re-add jinja to lock file as its implicitly required 2020-06-05 10:00:27 +00:00			`- Expression: policies/expression.md`
docs: add GitLab integration docs 2019-12-12 17:12:14 +00:00			`- Integrations:`
docs: add upgrade page 2020-05-16 21:46:25 +00:00			`- as Provider:`
			`- Amazon Web Services: integrations/services/aws/index.md`
			`- GitLab: integrations/services/gitlab/index.md`
			`- Rancher: integrations/services/rancher/index.md`
			`- Harbor: integrations/services/harbor/index.md`
			`- Sentry: integrations/services/sentry/index.md`
			`- Ansible Tower/AWX: integrations/services/tower-awx/index.md`
core: don't fail migrations if no pbadmin exists 2020-09-15 21:37:39 +00:00			`- VMware vCenter: integrations/services/vmware-vcenter/index.md`
docs: add docs for sonarr 2020-09-18 22:12:31 +00:00			`- Ubuntu Landscape: integrations/services/ubuntu-landscape/index.md`
			`- Sonarr: integrations/services/sonarr/index.md`
docs: add docs for Tautulli closes #244 2020-09-30 12:32:23 +00:00			`- Tautulli: integrations/services/tautulli/index.md`
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 18:36:36 +00:00			`- Maintenance:`
			`- Backups: maintenance/backups/index.md`
docs: add upgrade instructions for upcoming 0.10 2020-09-09 16:39:05 +00:00			`- Upgrading:`
			`- to 0.9: upgrading/to-0.9.md`
			`- to 0.10: upgrading/to-0.10.md`
docs: add docs for passbook_user_debug 2020-09-14 19:53:32 +00:00			`- Troubleshooting:`
			`- Access problems: troubleshooting/access.md`
docs: add initial structure, add docs for policies and factors 2019-12-09 20:00:45 +00:00
docs: fix some typos 2020-02-27 12:00:55 +00:00			`repo_name: "BeryJu/passbook"`
docker: fix old dockerfiles being used, remove all gitlab references 2019-12-30 09:34:31 +00:00			`repo_url: https://github.com/BeryJu/passbook`
docs: add initial structure, add docs for policies and factors 2019-12-09 20:00:45 +00:00			`theme:`
Merge branch 'master' into docs-flows # Conflicts: # mkdocs.yml 2020-06-05 10:51:10 +00:00			`name: material`
			`logo: images/logo.svg`
			`favicon: images/logo.svg`
			`palette:`
			`scheme: slate`
			`primary: white`
docs: add initial structure, add docs for policies and factors 2019-12-09 20:00:45 +00:00
docs: add docs for property mappings, switch to material theme 2019-12-10 10:25:34 +00:00			`markdown_extensions:`
docs: add providers and sources 2019-12-12 17:00:23 +00:00			`- toc:`
			`permalink: "¶"`
docs: use note blocks instead of code blocks for product description 2020-02-18 14:34:41 +00:00			`- admonition`
policies/expression: migrate to raw python instead of jinja2 (#49) * policies/expression: migrate to raw python instead of jinja2 * lib/expression: create base evaluator, custom subclass for policies * core: rewrite propertymappings to use python * providers/saml: update to new PropertyMappings * sources/ldap: update to new PropertyMappings * docs: update docs for new propertymappings * root: remove jinja2 * root: re-add jinja to lock file as its implicitly required 2020-06-05 10:00:27 +00:00			`- codehilite`
			`- pymdownx.betterem:`
			`smart_enable: all`
			`- pymdownx.inlinehilite`
			`- pymdownx.magiclink`
Merge branch 'master' into docs-flows # Conflicts: # mkdocs.yml 2020-06-05 10:51:10 +00:00			`- attr_list`
policies/expression: migrate to raw python instead of jinja2 (#49) * policies/expression: migrate to raw python instead of jinja2 * lib/expression: create base evaluator, custom subclass for policies * core: rewrite propertymappings to use python * providers/saml: update to new PropertyMappings * sources/ldap: update to new PropertyMappings * docs: update docs for new propertymappings * root: remove jinja2 * root: re-add jinja to lock file as its implicitly required 2020-06-05 10:00:27 +00:00
			`plugins:`
			`- search`