Adding self-hosted runners

You can add a self-hosted runner to a repository, an organization, or an enterprise.

If you are an organization or enterprise administrator, you might want to add your self-hosted runners at the organization or enterprise level. This approach makes the runner available to multiple repositories in your organization or enterprise, and also lets you to manage your runners in one place.

You can set up automation to scale the number of self-hosted runners. For more information, see Autoscaling with self-hosted runners.

You can register ephemeral runners that perform a single job before the registration is cleaned up by using just-in-time runner registration. For more information, see Security hardening for GitHub Actions.

Prerequisites

• GitHub Actions doit être activé pour GitHub Enterprise Server. Un administrateur de site peut activer et configurer GitHub Actions pour votre instance. Pour plus d’informations, consultez « Bien démarrer avec GitHub Actions pour GitHub Enterprise Server ».

• Vous devez avoir accès à la machine que vous allez utiliser en tant qu’exécuteur auto-hébergé dans votre environnement.

• La connexion entre exécuteurs auto-hébergés et GitHub passe via HTTP (port 80) ou HTTPS (port 443). Pour garantir la connectivité via HTTPS, configurez le protocole TLS pour GitHub Enterprise Server. Pour plus d’informations, consultez « Configuration de TLS ».

Adding a self-hosted runner to a repository

You can add self-hosted runners to a single repository. To add a self-hosted runner to a user repository, you must be the repository owner. For an organization repository, you must be an organization owner, have admin access to the repository, or have the “Manage organization runners and runner groups” permission.

For more information about custom organization roles, see À propos des rôles d'organisation personnalisés.

For information about how to add a self-hosted runner with the REST API, see Points de terminaison d’API REST pour les exécuteurs auto-hébergés.

1. Sur GitHub, accédez à la page principale du référentiel.

2. Sous le nom de votre dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

   

3. Dans la barre latérale gauche, cliquez sur Actions, puis sur Exécuteurs.

4. Click New self-hosted runner.

5. Sélectionnez l’image et l’architecture du système d’exploitation de votre machine d’exécuteur auto-hébergée.

   

6. Des instructions vous montrent comment télécharger l’application d’exécuteur et l’installer sur votre machine d’exécuteur auto-hébergée.

   Ouvrez un interpréteur de commandes sur votre machine d’exécuteur auto-hébergée et exécutez toutes les commandes shell dans l’ordre indiqué.

   Remarque

   Sur Windows, si vous souhaitez installer l’application d’exécuteur auto-hébergée en tant que service, vous devez ouvrir un interpréteur de commandes avec des privilèges d’administrateur. Nous vous recommandons également d’utiliser C:\actions-runner comme répertoire pour l’application de l’exécuteur auto-hébergé afin que les comptes système Windows puissent accéder au répertoire de l’exécuteur.

   Les instructions vous guident tout au long des tâches suivantes :

   • Téléchargement et extraction de l’application d’exécuteur auto-hébergée.
   • Exécution du script config pour configurer l’application d’exécuteur auto-hébergée et l’inscrire auprès de GitHub Actions. L’URL de destination et un jeton limité dans le temps généré automatiquement sont nécessaires pour permettre au script config d’authentifier la demande. Le jeton expire au bout d’une heure.
     • Sur Windows, le script config vous demande également si vous souhaitez installer l’application d’exécuteur auto-hébergée en tant que service. Pour Linux et macOS, vous pouvez installer un service une fois que vous avez terminé d’ajouter l’exécuteur. Pour plus d’informations, consultez « Configuring the self-hosted runner application as a service ».
   • Exécution de l’application d’exécuteur auto-hébergée pour connecter la machine à GitHub Actions.

Vérification de la réussite de l’ajout de votre exécuteur autohébergé

Après avoir effectué les étapes pour ajouter un exécuteur autohébergé, l’exécuteur et son statut sont listés sous « Exécuteurs autohébergé ».

L’application de l’exécuteur autohébergée doit être active pour que l’exécuteur accepte les travaux. Quand l’application d’exécuteur est connectée à GitHub et qu’elle est prête à recevoir des travaux, le message suivant s’affiche sur le terminal de la machine.

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

For more information, see Monitoring and troubleshooting self-hosted runners.

Adding a self-hosted runner to an organization

You can add self-hosted runners at the organization level, where they can be used to process jobs for multiple repositories in an organization. To add a self-hosted runner to an organization, you must be an organization owner or have the "Manage organization runners and runner groups" permission. For information about how to add a self-hosted runner with the REST API, see Points de terminaison d’API REST pour les exécuteurs auto-hébergés.

For more information about custom organization roles, see À propos des rôles d'organisation personnalisés.

1. Sur GitHub, accédez à la page principale de l’organisation.

2. Sous le nom de votre organisation, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.

   

3. Dans la barre latérale gauche, cliquez sur Actions, puis sur Exécuteurs.

4. Click New runner.

5. Sélectionnez l’image et l’architecture du système d’exploitation de votre machine d’exécuteur auto-hébergée.

   

6. Des instructions vous montrent comment télécharger l’application d’exécuteur et l’installer sur votre machine d’exécuteur auto-hébergée.

   Ouvrez un interpréteur de commandes sur votre machine d’exécuteur auto-hébergée et exécutez toutes les commandes shell dans l’ordre indiqué.

   Remarque

   Sur Windows, si vous souhaitez installer l’application d’exécuteur auto-hébergée en tant que service, vous devez ouvrir un interpréteur de commandes avec des privilèges d’administrateur. Nous vous recommandons également d’utiliser C:\actions-runner comme répertoire pour l’application de l’exécuteur auto-hébergé afin que les comptes système Windows puissent accéder au répertoire de l’exécuteur.

   Les instructions vous guident tout au long des tâches suivantes :

   • Téléchargement et extraction de l’application d’exécuteur auto-hébergée.
   • Exécution du script config pour configurer l’application d’exécuteur auto-hébergée et l’inscrire auprès de GitHub Actions. L’URL de destination et un jeton limité dans le temps généré automatiquement sont nécessaires pour permettre au script config d’authentifier la demande. Le jeton expire au bout d’une heure.
     • Sur Windows, le script config vous demande également si vous souhaitez installer l’application d’exécuteur auto-hébergée en tant que service. Pour Linux et macOS, vous pouvez installer un service une fois que vous avez terminé d’ajouter l’exécuteur. Pour plus d’informations, consultez « Configuring the self-hosted runner application as a service ».
   • Exécution de l’application d’exécuteur auto-hébergée pour connecter la machine à GitHub Actions.

Vérification de la réussite de l’ajout de votre exécuteur autohébergé

Après avoir effectué les étapes pour ajouter un exécuteur autohébergé, l’exécuteur et son statut sont listés sous « Exécuteurs autohébergé ».

L’application de l’exécuteur autohébergée doit être active pour que l’exécuteur accepte les travaux. Quand l’application d’exécuteur est connectée à GitHub et qu’elle est prête à recevoir des travaux, le message suivant s’affiche sur le terminal de la machine.

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

For more information, see Monitoring and troubleshooting self-hosted runners.

Adding a self-hosted runner to an enterprise

You can add self-hosted runners to an enterprise, where they can be assigned to multiple organizations. The organization owner can control which repositories can use it.

New runners are assigned to the default group. You can modify the runner's group after you've registered the runner. For more information, see Managing access to self-hosted runners using groups.

To add a self-hosted runner to an enterprise, you must be an enterprise owner. For information about how to add a self-hosted runner with the REST API, see the enterprise endpoints in the GitHub Actions REST API.

1. Dans le coin supérieur droit de GitHub Enterprise Server, cliquez sur votre photo de profil, puis sur Paramètres d’entreprise.

   

2. Sur le côté gauche de la page, dans la barre latérale du compte d’entreprise, cliquez sur Stratégies.

3. Sous « Stratégies  », cliquez sur Actions.

4. Cliquez sur l’onglet Exécuteurs.

5. Cliquez sur Nouvel exécuteur. 1. Sélectionnez l’image et l’architecture du système d’exploitation de votre machine d’exécuteur auto-hébergée.

   

6. Des instructions vous montrent comment télécharger l’application d’exécuteur et l’installer sur votre machine d’exécuteur auto-hébergée.

   Ouvrez un interpréteur de commandes sur votre machine d’exécuteur auto-hébergée et exécutez toutes les commandes shell dans l’ordre indiqué.

   Remarque

   Sur Windows, si vous souhaitez installer l’application d’exécuteur auto-hébergée en tant que service, vous devez ouvrir un interpréteur de commandes avec des privilèges d’administrateur. Nous vous recommandons également d’utiliser C:\actions-runner comme répertoire pour l’application de l’exécuteur auto-hébergé afin que les comptes système Windows puissent accéder au répertoire de l’exécuteur.

   Les instructions vous guident tout au long des tâches suivantes :

   • Téléchargement et extraction de l’application d’exécuteur auto-hébergée.
   • Exécution du script config pour configurer l’application d’exécuteur auto-hébergée et l’inscrire auprès de GitHub Actions. L’URL de destination et un jeton limité dans le temps généré automatiquement sont nécessaires pour permettre au script config d’authentifier la demande. Le jeton expire au bout d’une heure.
     • Sur Windows, le script config vous demande également si vous souhaitez installer l’application d’exécuteur auto-hébergée en tant que service. Pour Linux et macOS, vous pouvez installer un service une fois que vous avez terminé d’ajouter l’exécuteur. Pour plus d’informations, consultez « Configuring the self-hosted runner application as a service ».
   • Exécution de l’application d’exécuteur auto-hébergée pour connecter la machine à GitHub Actions.

Vérification de la réussite de l’ajout de votre exécuteur autohébergé

Après avoir effectué les étapes pour ajouter un exécuteur autohébergé, l’exécuteur et son statut sont listés sous « Exécuteurs autohébergé ».

L’application de l’exécuteur autohébergée doit être active pour que l’exécuteur accepte les travaux. Quand l’application d’exécuteur est connectée à GitHub et qu’elle est prête à recevoir des travaux, le message suivant s’affiche sur le terminal de la machine.

√ Connected to GitHub

2019-10-24 05:45:56Z: Listening for Jobs

For more information, see Monitoring and troubleshooting self-hosted runners.

Making enterprise runners available to repositories

By default, runners in an enterprise's "Default" self-hosted runner group are available to all organizations in the enterprise, but are not available to all repositories in each organization.

To make an enterprise-level self-hosted runner group available to an organization repository, you might need to change the organization's inherited settings for the runner group to make the runner available to repositories in the organization.

For more information on changing runner group access settings, see Managing access to self-hosted runners using groups.

Further reading

• À propos des exécuteurs auto-hébergés
• Bien démarrer avec les exécuteurs auto-hébergés pour votre entreprise