One Stone Soup

Warm community, open collaboration, sustainable living

Authentication — Install Instructions

Follow these steps to install the MemberServices AddOn on a new OpenForum site.


Prerequisites


Step 1 — Create the database tables

Run the SQL script on the DB page against your member database.

If upgrading from an existing member table, run only the ALTER TABLE statements to add the new lifecycle columns — do not drop the table.


Step 2 — Configure the site

Add the following keys to your site config object (the one stored via openForum.storeObject("config", ...)):
KeyDescriptionExample
databaseDB alias for the member databasemy-site-db
webAddressBase URL of the site (no trailing slash)https://mysite.example.com
adminEmailEmail address for admin notificationsadmin@mysite.example.com
setPasswordUrlPath to set-password page (optional, defaults to AddOn page)/SetPassword

Step 3 — Register the startup trigger

Open OpenForum > Settings > Startup Triggers and add: /OpenForum/AddOn/MemberServices/Registration/initialise.sjs This compiles the Registration service once at startup for fast request handling.

Step 4 — Set the magic token

Open Admin Page and ensure authentication.config contains a unique magic token value (not the default "magic").

Step 5 — Register the Admin account

Register the first account (Admin) using the Registration Form.

Step 6 — Run install.sjs

Open this page and run install.sjs. This will:

Step 7 — Smoke test

  1. Register a new test member at /OpenForum/AddOn/MemberServices/Register
  2. Check email for the verification link and follow it
  3. Set a password on the SetPassword page
  4. Sign in with the new credentials
  5. Test password reset via the sign-in page