GitHub Bitbucket Bitbucket Server GitLab GitLab on-premise Git

GitHub Authentication uses OAuth 2.0 to gain access to your files.

To obtain the configuration parameters listed below go to your GitHub Enterprise deployment in settings > applications > developer applications (http://enterprise-deployment.com/settings/applications/new) and register a new application.

Note: The Authorization callback URL must be set to:
web-author-context/plugins-dispatcher/github-oauth/callback

GitHub Authentication uses OAuth 2.0 to gain access to your files.

To obtain the configuration parameters required below, go to your GitHub OAuth Apps page and register a new application.

Note that 'Authorization callback URL' must be set to:
web-author-context/plugins-dispatcher/github-oauth/callback


Retrieve documents strategy:
? Documents are retrieved via individual HTTP(S) requests to the REST API of the Git server.
? To speed up document loading, the repository is briefly cloned in memory. After loading, the application discards the clone and switches to HTTP(S) requests to the REST API of the Git server.

Bitbucket Authentication uses OAuth 2.0 to gain access to your files.

To obtain the configuration parameters listed below go to the Bitbucket workspaces page and select one of your workspaces. Afterwards go to your workspace settings > OAuth consumers and add a new consumer.

The available permissions must be: Account:read, Pull requests:write & Repositories:admin

Note: The Callback URL must be set to:
web-author-context/plugins-dispatcher/bitbucket-oauth/callback

After saving you will find the Key and Secret by clicking on the consumer name.


Retrieve documents strategy:
? Documents are retrieved via individual HTTP(S) requests to the REST API of the Git server.
? To speed up document loading, the repository is briefly cloned in memory. After loading, the application discards the clone and switches to HTTP(S) requests to the REST API of the Git server.

Bitbucket Server Authentication uses OAuth 1.0a to gain access to your files.

To integrate Web Author with Bitbucket Server, you need to create an application link in the Administration > Application Links page of your Bitbucket Server instance.

Enter the home page address of your Oxygen XML Web Author instance as the application URL and click Create new link.

A Configure Application URL dialog prompts you to confirm the URL. Check that it is correct and click Continue.

In the Link applications dialog, in the Application Name field, define a name for the application link to Web Author. Check that the Application Type is set to Generic Application. Leave all the other fields blank and click Continue.

The Configure Application Links page now displays the new application link to Web Author. Click on the pencil under the Actions column to edit the application link.

Click on the Incoming Authentication tab to configure the OAuth 1.0a parameters.

Enter a Consumer Key - it must be unique in regard to other application links and be the same as the one you will enter here. Next, enter a Consumer Name, the Public Key, and Consumer Callback URL (provided below), then Save and Close.


Retrieve documents strategy:
? Documents are retrieved via individual HTTP(S) requests to the REST API of the Git server.
? To speed up document loading, the repository is briefly cloned in memory. After loading, the application discards the clone and switches to HTTP(S) requests to the REST API of the Git server.

GitLab Authentication uses OAuth 2.0 to gain access to your files.

To obtain the configuration parameters listed below go to your GitLab applications page (https://gitlab.com/-/profile/applications) and create a new application.

The available scopes must be: api: Access your API, read_user: Read user information

Note: The Redirect URI must be set to:
web-author-context/plugins-dispatcher/gitlab-oauth/callback
both in this dialog and on the GitLab page.


Retrieve documents strategy:
? Documents are retrieved via individual HTTP(S) requests to the REST API of the Git server.
? To speed up document loading, the repository is briefly cloned in memory. After loading, the application discards the clone and switches to HTTP(S) requests to the REST API of the Git server.

GitLab On Premise Authentication uses OAuth 2.0 to gain access to your files.

To obtain the configuration parameters listed below, open your GitLab Enterprise in a browser, go to Preferences, Applications and create a new application.

The available scopes must be: api: Access your API, read_user: Read user information

Note: The Redirect URI must be set to:
web-author-context/plugins-dispatcher/gitlab-e-oauth/callback
both in this dialog and on the GitLab page.


Retrieve documents strategy:
? Documents are retrieved via individual HTTP(S) requests to the REST API of the Git server.
? To speed up document loading, the repository is briefly cloned in memory. After loading, the application discards the clone and switches to HTTP(S) requests to the REST API of the Git server.