Skip to content
DocuBot documentation

Authentication guide

This guide explains how to authenticate with DocuBot to access your workspace and connect your GitHub repositories for documentation generation.

Authentication overview

DocuBot uses two distinct authentication layers to ensure your data is secure while allowing the system to access your source code:

  • Google Sign-In: Used to create your account and access the DocuBot management dashboard.
  • GitHub OAuth: Used to authorize DocuBot to read your repository content, specifically for private repositories.

Access your workspace

You access your DocuBot dashboard using your Google account. This ensures a secure, passwordless login experience.

  1. Navigate to the DocuBot landing page.
  2. Click the Sign in button in the top header.
  3. Select the Google account you wish to use.
  4. Verify your identity through the standard Google authentication prompt.

Once verified, the system redirects you to your workspace overview.

Connect to GitHub

To generate documentation from private repositories, you must authorize DocuBot via GitHub OAuth. While public repositories do not strictly require this connection, connecting your GitHub account ensures a smoother integration for all your projects.

  1. Open your DocuBot dashboard and navigate to Settings.
  2. Locate the GitHub connection section.
  3. Click Connect GitHub.
  4. You are redirected to GitHub. Review the requested permissions, which include read access to your repositories and user profile.
  5. Click Authorize to grant access.
  6. GitHub redirects you back to the DocuBot dashboard.

The status in your settings now shows as Connected, and your GitHub username appears in the workspace details.

Manage your credentials

You can review your connection status and account details at any time within the dashboard.

View profile details

Navigate to the Profile page to see your display name, email address, and profile photo associated with your Google account. This page also provides the option to sign out of your current session.

Check integration status

Navigate to the Settings page to verify if your GitHub account is currently linked. If you need to refresh your permissions or connect a different account, you can manage those settings here.

Security and token handling

DocuBot manages your integration tokens automatically. When you authorize GitHub access, the system securely stores the necessary metadata to perform scheduled and manual sync jobs.

  • Automatic sync: Your connected credentials allow DocuBot to pull the latest code changes during your scheduled update window without requiring you to be signed in.
  • Secure storage: All integration tokens are handled server-side and are never exposed in the public documentation or the browser.

If you encounter issues with authentication or need to revoke access, please contact our support team at support@ademero.com or visit https://www.ademero.com. You can also reach us by phone at 863-937-0272.

Next steps

After authenticating, you can begin setting up your documentation projects.