It is possible to provide a token or credentials for a number of external services. These may be used to lift a rate limit or provide access to private resources from a self-hosted instance.
There are two ways of setting secrets:
- Via environment variables. This is a good way to set them in a PaaS environment.
- Via checked-in
private: gh_token: '...'
For more complex scenarios, configuration files can cascade. See the node-config documentation for details.
An Azure DevOps Token (PAT) is required for accessing private Azure DevOps projects.
Test Management (read)
The bintray API requires authentication Create an account and obtain a token from the user profile page.
The self-hosted Drone API requires authentication Login to your Drone instance and obtain a token from the user profile page.
Because of Github rate limits, you will need to provide a token, or else badges will stop working once you hit 60 requests per hour, the unauthenticated rate limit.
You can create a personal access token through the Github website. When you create the token, you can choose to give read access to your repositories. If you do that, your self-hosted Shields installation will have access to your private repositories.
gh_token is specified, it is used in place of the Shields token
These settings are used by shields.io for GitHub OAuth app authorization but will not be necessary for most self-hosted installations. See production-hosting.md.
Provide a username and password to give your self-hosted Shields installation access to a private Jenkins CI instance.
Provide a username and password to give your self-hosted Shields installation access to a private JIRA instance.
Provide a username and password to give your self-hosted Shields installation access to your private nexus repositories.
Generate an npm token to give your self-hosted Shields installation access to private npm packages
SymfonyInsight (formerly Sensiolabs)
The SymfonyInsight API requires authentication. To obtain a token, Create an account, sign in and obtain a uuid and token from your account page.
Generate a token to give your self-hosted Shields installation access to a private SonarQube instance or private project on a public instance.
The wheelmap API requires authentication. To obtain a token, Create an account, sign in and use the Authentication Token displayed on your profile page.