Skip to main content

Connect a Codebase with GitLab Self-Managed

How to connect a codebase with GitLab Self-Managed.

Driver supports multiple ways of connecting your code to automate documentation and use them to create richer, customized documents. You can upload codebase files piecemeal, but configuring a Git provider gets you additional features like automatic updates.
​


Configuring a Git Provider to Connect Codebase Sources

When you first set up a Driver workspace, you'll be prompted to configure a Git provider. Subsequently, you can find all these configuration settings in Settings>Integrations.


​

Configuring GitLab Self-Managed

  1. If you are setting up your Driver workspace for the first time, select + Configure Git Provider from the Home page. You'll be taken to the Integrations settings page, which is viewable only by workspace Admins.
    ​


    ​

  2. Under GitLab Self-Managed, select + Authorize.
    ​


    ​

  3. In the dialog that appears, name your instance and paste in your URL.
    ​


    ​

  4. In GitLab, navigate to Groups. Select the group you want to connect to Driver, or create a new group.
    ​


    ​

  5. Navigate to that group's Settings>Access tokens page.
    ​


    ​

  6. Add a new token to use with Driver.

    • Give it a unique name and set an appropriate expiration date.

    • Give it at least a minimum role of Maintainer, or Owner.

    • Select the scopes api, read_api, and read_repository.

    • Save the new token, and copy the unique name and token value.
      ​
      ​

  7. In Driver, navigate to Settings>Integrations. Under GitLab Self-Managed, select the new + Add Token button.
    ​


    ​

  8. You'll be prompted with a dialog to paste in your group name and unique token value. Enter the values for Group Name and Group Access Token, and save the information.
    ​


    ​

Selecting Codebases to Connect to Driver

  1. Now you'll be able to select the Manage Repositories button.
    ​


    ​

  2. Now select the codebases that you want available in your Driver workspace.
    ​


    ​

  3. Navigate to My Sources to find the codebases you connected. Connected codebases do *not* count towards your sloc limit until you choose to generate docs. Learn more about our pricing here.
    ​

Did this answer your question?