Haruno Knowledge base

Knowledge base readers

Give people a key to the internal knowledge base, take it away, and choose who may read the operator pages. Only a super admin can do this.

  • Operator consoleAvailable

The knowledge base is the internal site that explains what Haruno does. It is not open to everyone. Each person who reads it has their own key, and you make it here.

A key opens the knowledge base and nothing else. It gives no access to this console.

Open Knowledge base in the sidebar. The page is only there for a super admin. Anyone else who reaches it sees a message that it is restricted.

What you can see

The Readers tab lists everyone who has a key: their name, email, access, status, and when they last opened the knowledge base.

  • Reader can read every page except the pages about this console.
  • Operator can read those pages too.
  • Active means the key works. Disabled means it does not.

The other two tabs, Dialogs and Gaps, are empty for now.

What you can do

  • New reader makes a key for a person.
  • New key replaces a person's key.
  • Disable stops a key working without deleting the person. Enable turns it back on.
  • Press Reader or Operator in the Access column to change who may read the operator pages.
  • The bin button deletes the reader.

Every action is recorded.

Giving someone a key

  1. Press New reader.
  2. Type their Name. The Email is optional. It only reminds you who the key is for.
  3. Tick Can read the operator pages only for people on the operations team.
  4. Press Create.
The key is shown once

A window called "Key ready" shows the key. Copy it and send it to the person over a channel you trust. It cannot be read again. If it is lost, use New key to make another.

The person opens the knowledge base, pastes the key, and stays signed in for up to 30 days.

Taking access away

  • Disable and New key sign the person out of every browser they were using, and the old key stops working.
  • Enable gives the key back, but a browser that was signed in before has to sign in again.
  • Delete removes the person for good.

Good to know

  • Give each person their own key. Then you can disable one without affecting the others.
  • A change can take up to 30 seconds to reach the site. A person you just disabled may still open a page for that long.
  • Too many wrong keys from one place lock that place out for a few minutes. You do not need to do anything.
  • Until you add someone, nobody can open the knowledge base.

Last updated · PR #2944 · View this version on GitHub

History (1 version)
  1. Internal knowledge base for staff: site, reader keys, assistant, 197 pages and the PR rule (#2944)
    PR #2944Commit a2a7836The page at this version
    What changed
    @@ -0,0 +1,63 @@
+---
+title: Knowledge base readers
+summary: Give people a key to the internal knowledge base, take it away, and choose who may read the operator pages. Only a super admin can do this.
+feature: ops-kb-readers
+covers:
+  - web/monitoring/components/KbPage.tsx
+  - web/monitoring/components/KbReadersTab.tsx
+  - web/monitoring/lib/kbApi.ts
+  - server-dotnet/src/Haruno.Server/Controllers/AdminKbReadersController.cs
+  - server-dotnet/src/Haruno.Server/Services/Kb/KbReaderService.cs
+---
+
+The knowledge base is the internal site that explains what Haruno does. It is not open to everyone. Each person who reads it has their own key, and you make it here.
+
+A key opens the knowledge base and nothing else. It gives no access to this console.
+
+Open **Knowledge base** in the sidebar. The page is only there for a **super admin**. Anyone else who reaches it sees a message that it is restricted.
+
+## What you can see
+
+The **Readers** tab lists everyone who has a key: their name, email, access, status, and when they last opened the knowledge base.
+
+- **Reader** can read every page except the pages about this console.
+- **Operator** can read those pages too.
+- **Active** means the key works. **Disabled** means it does not.
+
+The other two tabs, **Dialogs** and **Gaps**, are empty for now.
+
+## What you can do
+
+- **New reader** makes a key for a person.
+- **New key** replaces a person's key.
+- **Disable** stops a key working without deleting the person. **Enable** turns it back on.
+- Press **Reader** or **Operator** in the Access column to change who may read the operator pages.
+- The bin button deletes the reader.
+
+Every action is recorded.
+
+## Giving someone a key
+
+1. Press **New reader**.
+2. Type their **Name**. The **Email** is optional. It only reminds you who the key is for.
+3. Tick **Can read the operator pages** only for people on the operations team.
+4. Press **Create**.
+
+<Callout variant="warning" title="The key is shown once">
+A window called "Key ready" shows the key. Copy it and send it to the person over a channel you trust. It cannot be read again. If it is lost, use **New key** to make another.
+</Callout>
+
+The person opens the knowledge base, pastes the key, and stays signed in for up to 30 days.
+
+## Taking access away
+
+- **Disable** and **New key** sign the person out of every browser they were using, and the old key stops working.
+- **Enable** gives the key back, but a browser that was signed in before has to sign in again.
+- **Delete** removes the person for good.
+
+## Good to know
+
+- Give each person their own key. Then you can disable one without affecting the others.
+- A change can take up to 30 seconds to reach the site. A person you just disabled may still open a page for that long.
+- Too many wrong keys from one place lock that place out for a few minutes. You do not need to do anything.
+- Until you add someone, nobody can open the knowledge base.