Set up your Artifactory

This page is not available in the language you requested. You have been redirected to the English version of the page.

Link to this page copied to clipboard

Configuring your Artifactory instance to connect to Deque's Agora artifact repository

Not for use with personal data

Configuring your Artifactory repository to connect to Deque’s Agora artifact repository

Follow these steps when you want to connect to Deque’s Agora artifact repository from your Artifactory instance. Setting up this authenticated remote repository within Artifactory allows your users to access Axe DevTools components through your own software distribution network.

Prerequisites

You must have Agora login credentials and admin credentials for your Artifactory instance to configure this repository connection. Deque recommends using an Agora service account for those credentials rather than a personal account.

Using a Service Account

Deque recommends that you authenticate this connection with an Agora service account rather than with your own Agora login. A service account is an Agora account that belongs to your team rather than a personal account that belongs to only one team member.

Your repository manager — the server that hosts the remote repository you are setting up — stores the service account's credentials and uses them whenever it needs to reach Agora. It does not download the packages ahead of time. The first time one of your developers or build pipelines installs an Axe DevTools package, the remote repository fetches that package from Agora and keeps a copy, and later installs are served from the copy. Your developers and automated systems only ever request packages from your repository manager, so they never need their own Agora accounts.

A connection built on a single person's login depends on that person keeping Agora access. If they leave your organization, no one can sign in to their account to recreate the Identity Token when it expires, and installs then fail for everyone. A service account does not depend on one person.

Looking After the Service Account

Treat the service account's Identity Token — the password-like credential Agora issues for the account — as a shared infrastructure credential, and manage it following your organization's security and credential policies. Store it in a secrets manager or your CI provider's secret store and reference it from your repository manager's configuration, rather than committing it to source control. Ask Deque to scope the service account to only the read access it needs when you request it, and ask us to revoke and reissue the token if it may have been exposed or when the account owner changes.

Assign an owner to the account from within your organization. Identity Tokens expire (usually after a year), so the account owner must recreate the token before it expires. Whoever recreates it must also update the stored token that your repository manager uses to connect to Agora, because your repository manager cannot download new and updated packages until the stored token is updated.

note

To request a service account, contact your Deque representative directly, ask us via our support desk, or send us an email. We'll be happy to help you set one up.

Creating an Agora Identity Token

To begin, sign in to Agora as the service account, so that the Identity Token belongs to the service account rather than to a personal account. If you are not using a service account, sign in as yourself. Click the Welcome button in the top right corner to open the profile page. Generate an Identity Token there and copy it.

important

Remember to copy your Identity Token's value when creating it, as this will be your only opportunity. Otherwise, you'll have to create a new token.

Identity Tokens expire (usually after a year), so you'll need to recreate your token periodically.

Connecting to Agora

Sign into your Artifactory Repository Manager with your admin credentials.
Select Admin in the left navigation menu.
Select “Remote” under “Repositories” to display the remote repositories page.
Select “Create New” in the upper right of the Remote Repositories page.
The page should display a listing of package types
Select your package type (e.g. npm)
The create repository: page should display a form (see above example of an npm repository).
1. In the Repository Key field, type the name you would like to use to refer to the repository. The repository key must not contain spaces or special characters, must be unique, must not begin with a number, and is limited to 58 characters.
2. Enter the URL to the Agora registry (see Agora Registry URLs below).
3. Select the appropriate layouts (defaults should work for each repository type)
Click the “Test” button to test the connection
Click “Save and Finish”
If you want users to use this repository by default you will have to include it in any of your virtual registries

Agora Registry URLs

important

These links are not meant to be visited. Instead, right-click on the link you want, choose Copy Link, and then paste the URL into the Agora setup page for the Agora registry's URL.