Last updated

Project 10: Protected content

ScheduleFlex Meld
Time allowed2 hours

Update Realm

Update to the latest minor version of Realm.

At the time I write this, it's 0.89.0-rc.1.

Cheat: How to do this

Edit the package.json and replace the version of Realm with 0.89.0-rc.1 (or any other latest version).

package.json
 "dependencies": {
    "@redocly/realm": "0.89.0-rc.1"
  }

This is an experimental RC version which may be a bit unstable. Known issues:

  • Scorecard is not functional at all.

Please, report any issues in the slack thread.

Lock It Down!

The boss wants to keep all of our API documentation under wraps - for our partners' eyes only! It's time to put our entire website behind a login.

The boss still did not decide if we're using Redocly "Enterprise" or "Pro" plan so, just in case, don't use "rbac" as it's an "Enterprise" feature.

Task 1: Protect your website

  1. Configuration: Enable login protection for your website.

  2. Test: Log out of your Redocly account and try to access your website. You should be redirected to the login page.

    Cheat: Link to the docs (if you really need it)

    Try to find it youself! You can't? Okay, here you go.

Task 2: Invite Your crew

  1. Access control: Invite two people to join your organization as Viewers. This role gives them access to your protected website.
  • Also, please, invite Adam and Roman H too (if they are not already invited as Owner/Member).
  1. Verify access: Ask your invited colleagues to log in and confirm they can see your website content.

Debrief

Debrief on your experience. What made you smile? What did you find confusing?