Deploying Oxygen XML Web Author / Supported Plugin Integrations Parent topic: Supported Plugin Integrations

Configuring a GitHub Integration

The Oxygen XML SDK includes a plugin that allows you to use the Oxygen XML Web Author to edit files stored in a GitHub repository.

You can configure your GitHub integration to use the OAuth authentication method to access files stored in a public or private repository. You will then have access to a Login with GitHub button in the GitHub login dialog box. You can configure your integration either by using github.com or with a GitHub Enterprise deployment.

Configure a GitHub Integration with github.com

To configure your GitHub integration using github.com, follow this procedure:
  1. Login to GitHub and register a new developer application at https://github.com/settings/applications/new.
    1. Complete the form.
    2. The Authorization callback URL field should include the following path: [OXYGEN_WEBAPP_INSTALL_DIR]/plugins-dispatcher/github-oauth/callback.
  2. Click on Register application to obtain the Client ID and Client Secret credentials (they are displayed at the top-right section of the resulting page).
  3. Set your Client ID and Client Secret credentials in your plugin configuration by doing one of the following:
    • Go to the Administration Page, in the Plugins section click on the Configure icon for the GitHub plugin, and enter the Client ID and Client Secret in the Plugin configuration dialog box.
    • Create a new properties file called github-plugin.properties in the WEB-INF folder of the OXYGEN-WEBAPP directory and add your Client ID and Client Secret credentials with the following structure:
      client_id=<client_id>
client_secret=<client_secret>
  4. Restart the Oxygen XML Web Author.

Result: You now have access to the Login with GitHub button in the GitHub login dialog box.

Configure a GitHub Integration with a GitHub Enterprise Deployment

To configure your GitHub integration using a GitHub Enterprise deployment, follow this procedure:
  1. Login to GitHub Enterprise and register a new developer application. The URL is: [GithubEnterpriseUrl]/settings/applications/new.
    1. Complete the form.
    2. The Authorization callback URL field should include the following path: [OXYGEN_WEBAPP_INSTALL_DIR]/plugins-dispatcher/github-oauth/callback.
  2. Obtain the Client ID and Client Secret credentials at: [GithubEnterpriseUrl]/settings/developers.
  3. Set the Client ID, Client Secret, and the API URL in your plugin configuration by doing the following:
    1. Go to the Administration Page.
    2. In the Plugins section, click on the Configure icon for the GitHub plugin, enable the Use GitHub Enterprise option, and enter the API URL, Client ID, and Client Secret in the Plugin configuration dialog box. The API URL is the URL of your GitHub Enterprise deployment ([GithubEnterpriseUrl]).
  4. Restart the Oxygen XML Web Author.

Result: You now have access to the Login with GitHub button in the GitHub login dialog box.

Parent topic: Supported Plugin Integrations