backdrop-contrib / bakery

Allows for single sign-on between Backdrop sites on the same domain.
GNU General Public License v2.0
1 stars 3 forks source link

Bakery module

Provides single sign-on (SSO) functionality for two or more sites.

Deploy this module on the authoritative "master" Backdrop server and the secondary "slave" or subsite server. The master and slave must be on the same domain*.

Installation

  1. Install this module using the official Backdrop CMS instructions at https://backdropcms.org/guide/modules

  2. Visit the configuration page under Administration > Configuration > System > Bakery (admin/config/system/bakery) and configure, as described below.

Set-Up

Enable and configure Bakery on the master server first. It is recommended that you use the UID 1 Backdrop account for this configuration.

This is the master site:

  1. Check the box for "Is this the master site?"
  2. Enter the full URL of this site, including ending forward slash

For SSO to work, Bakery must know the slave, or subsites, to use.

  1. Enter the full URLs of each slave site, separated by newlines

Two other required fields for Bakery to work are the private key and the cookie domain.

  1. Enter a long and secure private key
  2. Enter the domain to use for Bakery cookies. These cookies are shared so the domain should be the top level, with leading period.
    • Example: .example.org
  3. Save configuration (we'll come back to the other fields)

Now to enable and configure Bakery on the slave or subsite. If possible, you should log in and use the UID 1 Backdrop account for this configuration.

  1. Enable Bakery at admin/modules
  2. Visit admin/config/system/bakery to configure

This is a subsite site.

  1. Do not check the master site box
  2. Enter the full URL of the master site set in step #4
  3. The slave sites textarea can be left blank
  4. Enter the exact same private key set in step #6
  5. Enter the exact same domain set in step #7
  6. Save configuration (we'll come back to the other fields)

Bakery should now be set to work for the master and this slave site. Open a different browser than the one you are currently using and visit the master site. Log in with a standard account. Once successful visit the slave site and confirm that you are also logged in. If you encountered problems at any point please consult the section here labeled "Problems and support".

You can now enable and configure Bakery for sites in your network if required, or read the section labeled "Sharing account information using Bakery".

Documentation

Additional documentation is located in the Wiki: https://github.com/backdrop-contrib/bakery/wiki/Documentation

Issues

Bugs and Feature requests should be reported in the Issue Queue: https://github.com/backdrop-contrib/bakery/issues

Current Maintainers

Credits

License

This project is GPL v2 software. See the LICENSE.txt file in this directory for complete text.