Access Control

Guidebook Cloud allows you to control who can access your documentation. Access rules are configured at the organization level and apply to all repositories.

Rule Types

Guidebook Cloud supports the following rule types:

Rule TypeDescription
IP AllowlistRestrict access by IP address or CIDR range

How Rules Work

Access is granted when the user's request matches the configured rules:

Access = IP matches any IP rule OR no IP rules configured

No Rules Configured

If no access rules are configured:

  • Anyone with the URL can access the documentation
  • This is useful for public documentation

IP Rules Only

If IP rules are configured:

  • The user's IP address must match at least one IP rule
  • Access is denied if the IP does not match any rule

Managing Access Rules

Adding a Rule

  1. Go to SettingsAccess Control
  2. Click Add Rule
  3. Select the rule type
  4. Enter the rule value
  5. Click Add Rule

Deleting a Rule

  1. Go to SettingsAccess Control
  2. Find the rule in the list
  3. Click Delete
  4. Confirm the deletion

Best Practices

Internal Documentation

  1. Configure IP rules at the organization level
  2. Allow only office IP addresses

Security Considerations

  • Review rules periodically and remove unnecessary ones
  • Consider VPN access when configuring IP ranges