Addon implementing OAuth2 / OpenId Login in Volto sites.

This addon requires a server-side package to be installed. Currently we support one of the following:

• pas.plugins.authomatic version 2.0.0b2 or superior
• pas.plugins.oidc version 2.0.0a1 or superior

volto-authomatic can be seen in action at the following sites:

• Plone
• Plone Brasil
• 2024 Plone Conference
• 2023 Plone Conference
• 2022 Plone Conference
• 2021 Plone Conference

To install your project, you must choose the method appropriate to your version of Volto.

Add @plone-collective/volto-authomatic to your package.json:

"dependencies": {
    "@plone-collective/volto-authomatic": "*"
}

Add @plone-collective/volto-authomatic to your volto.config.js:

const addons = ['@plone-collective/volto-authomatic'];

Visit http://localhost:3000/ in a browser, login, and check the awesome new features.

When using this package alongside pas.plugins.authomatic on the backend, you can optionally enable Plone’s native login as one of the available authentication providers.

To do this, set config.settings.showPloneLogin to true in your project configuration. By default, this option is set to false.

Edit your project's index.js and update the applyConfig function:

const applyConfig = (config) => {
  config.settings.showPloneLogin = true;
  return config;
};

export default applyConfig;

The setup is similar, but you’ll also need to extend the type definition to your index.ts:

import type { ConfigType } from '@plone/registry';

declare module '@plone/types' {
  export interface SettingsConfig {
    showPloneLogin: boolean;
  }
}

export function applyConfig(config: ConfigType) {
  config.settings.showPloneLogin = true;
  return config;
}

export default applyConfig;

The development of this add-on is done in isolation using a new approach using pnpm workspaces and latest mrs-developer and other Volto core improvements. For this reason, it only works with pnpm and Volto 18 (currently in alpha).

• An operating system that runs all the requirements mentioned.
• nvm
• Node.js and pnpm 22
• Make
• Git
• Docker (optional)

1. Clone this repository, then change your working directory.

   git clone git@github.com:collective/volto-authomatic.git
   cd volto-authomatic

2. Install this code base.

   make install

Run make help to list the available commands.

help                             Show this help
install                          Installs the add-on in a development environment
start                            Starts Volto, allowing reloading of the add-on during development
build                            Build a production bundle for distribution of the project with the add-on
i18n                             Sync i18n
ci-i18n                          Check if i18n is not synced
format                           Format codebase
lint                             Lint, or catch and remove problems, in code base
release                          Release the add-on on npmjs.org
release-dry-run                  Dry-run the release of the add-on on npmjs.org
test                             Run unit tests
ci-test                          Run unit tests in CI
backend-docker-start             Starts a Docker-based backend for development
storybook-start                  Start Storybook server on port 6006
storybook-build                  Build Storybook
acceptance-frontend-dev-start    Start acceptance frontend in development mode
acceptance-frontend-prod-start   Start acceptance frontend in production mode
acceptance-backend-start         Start backend acceptance server
ci-acceptance-backend-start      Start backend acceptance server in headless mode for CI
acceptance-test                  Start Cypress in interactive mode
ci-acceptance-test               Run cypress tests in headless mode for CI

Install package requirements.

make install

Start the backend.

make backend-docker-start

In a separate terminal session, start the frontend.

make start

Run ESlint, Prettier, and Stylelint in analyze mode.

make lint

Run ESlint, Prettier, and Stylelint in fix mode.

make format

Extract the i18n messages to locales.

make i18n

Run unit tests.

make test

Run each of these steps in separate terminal sessions.

In the first session, start the frontend in development mode.

make acceptance-frontend-dev-start

In the second session, start the backend acceptance server.

make acceptance-backend-start

In the third session, start the Cypress interactive test runner.

make acceptance-test

The project is licensed under the MIT license.

Generated using Cookieplone (0.9.7) and cookieplone-templates (0d65af5) on 2025-04-29 21:39:34.945036. A special thanks to all contributors and supporters!