ReadMe Documentation

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Setting Up Access Control

Setting up access is tricky. We're here to help though! We've taken a couple of measures to make sure that we can support some common use cases that our enterprise clients have. Here, we'll take a look at how some of our customers are integrating their SAML access to manage private access.

We think it's useful to think about your access in two main channels: internalinternal - Your administrators that can access the dashboard of your projects & externalexternal - Your members that have access to the hubs.

With that being said, there are a few ways you can set up access. Below, we'll lay out each steps on how to implement a solution:

  • My documentation is totally private and I want my externalexternal - Your members that have access to the hubs users to log in via SAML
  • Some of my projects will be private and I want my externalexternal - Your members that have access to the hubs users to log in via SAML
  • I want my internalinternal - Your administrators that can access the dashboard of your projects users to log in via SAML and I want my externalexternal - Your members that have access to the hubs users to log in via Custom OAuth.
  • I have a totally custom solution and want my users to log in via that.

๐Ÿšง

Did you set up SAML yet?

If you haven't set up your SAML set up yet, check out this piece to get that started. In addition, this guide assumes that you have an enterprise parent project set up with ReadMe.

Scenario 1: My documentation is totally private and I want my externalexternal - Your members that have access to the hubs users to log in via SAML

We'll divide up the work into two pieces:

  1. Setting up the private docs
  2. Setting up your login mechanismslogin mechanisms - ReadMe's login mechanisms. We can support Custom OAuth, Custom JWT, SAML, Local ReadMe, and No Login

Setting up private docs

Setting this up is quite easy. You can toggle the "Private Docs" control and your project will be turned into a private project.

Green means it's private!

Setting up your login mechanism

We have four login mechanismslogin mechanisms - ReadMe's login mechanisms. We can support Custom OAuth, Custom JWT, SAML, Local ReadMe, and No Login. When you have correctly set up your project, you will be able to control how your externalexternal - Your members that have access to the hubs members will log in to the private project. One thing to note though, is that you may not need to set this up, if you have set up SAML already, your externalexternal - Your members that have access to the hubs users will already be prompted to log in with SAML.

Options are only enabled if you've set them up.

Scenario 2: Some of my projects will be private and I want my externalexternal - Your members that have access to the hubs users to log in via SAML

This is very similar to scenario 1. All you would need to do to keep some docs public is to determine which ones you want private and only toggle those ones.

Scenario 3: I have a totally custom solution and want my external users to log in via that.

If you want to do this, you can use a custom login URL which you can specify here: https://dash.readme.io/project/[YOUR PROJECT]/[VERSION]/custom-login


Did this page help you?