How-to guides

Contents

How-to guides#

How-to guides are directions that guide you through a problem or toward a result. How-to guides are goal-oriented.

Each guide assumes you already know what you want. If you want to understand why something works the way it does, read Concepts instead—and if you are new here, start with Mental model.

Find a guide#

To get a site running, work through Install and upgrade and then Sign in with a provider, in that order.

📦 Install and upgrade

Install the backend and the frontend, and upgrade an existing site.

Install and upgrade
🔑 Sign in with a provider

Let people sign in with Google, GitHub, Keycloak, another Plone site, or any OpenID Connect provider.

Sign in with a provider
⚖️ Decide what a provider may do

Link accounts by email, control account creation, and map a provider's groups.

Decide what a provider may do
🩺 Operate a site

Troubleshoot sign-in, read the audit log, review an account, enable back-channel logout, and move principals.

Operate a site
🪪 Act as an identity provider

Let other applications sign their users in against your site.

Act as an identity provider
🚚 Migrate from other plugins

Move from pas.plugins.authomatic or pas.plugins.oidc.

Migrate from other plugins
🧩 Extend the package

Write drivers, profile enrichers, and claims, and extend the user catalog and profile pages.

Extend the package