Tutorial

Part of a tutorial: Step 11 of 11 · Optional in Launch Laramin for your business

Open in tutorial
In this section · 14 articles

Connect your installation to the Help Center

Set your Help Center's address and connect your installation, so people can open help from the header already signed in, and see the docs for your organization's own modules.

Applies to
Core 12.7 and later
Who can do this
Platform owner
Permission
feature.core.help_portal.edit
Where
Configurations › General Settings › Help Center
On this page

Before you start

  • This panel is for super admins only. Its permissions, feature.core.help_portal.view and feature.core.help_portal.edit, are left out of the standard Administrator role, because Connect creates sign-in credentials.
  • Get your Help Center's address from your Laramin provider, for example https://help.example.com. It may already be filled in for you.
  • Connecting is what lets people sign in to the Help Center with their Laramin account. Public articles work without it.

Set the address and connect

  1. Open Configurations › General Settings › Help Center.

  2. In Help Center URL, check or enter the address, then select Save changes. It must start with https://.

  3. Select Connect.

  4. A dialog, Enter these in the Help Center, shows three values: Install URL, Client ID and Client secret. Select Copy beside each one.

    Careful: The client secret is shown only this once. Copy it before you close the dialog. If you lose it, use Rotate secret to get a new one.

  5. Send the three values to your Laramin provider through a secure channel, not plain email. They add your installation to the Help Center. If you manage the Help Center yourself, enter them in its admin screen under Installations › Add installation.

  6. Select I've copied them.

The panel now says Connected since and the date.

What happens next

Once the Help Center has your details, people with Open the Help Center are signed in on the way when they select ? in the header. See Open the Help Center.

Change the secret

Select Rotate secret and confirm. Signing in to the Help Center stops working until the new secret is entered in the Help Center, so send it straight away.

Disconnect

Select Disconnect and confirm. Nobody can sign in to the Help Center through this installation until you connect again. The Help link stays, and opens the public articles.

From the server

Someone with server access can do the same without signing in:

CommandWhat it does
php artisan help-portal:client --portal=https://help.example.comSaves the address and connects, replacing any earlier connection. Prints the three values.
php artisan help-portal:client --rotateIssues a new secret.
php artisan help-portal:client --revokeDisconnects.

The address can also be set in the environment file as HELP_PORTAL_URL. The panel's Help Center URL overrides it.