Skip to main content

GitHub

Overview​

Currently, local installations of BeetleboxCI support manual Github integration. This requires users to provide the URL of Github repositories (alongside credentials to access those repositories if needed).

Adding a Public Github Repository to BeetleboxCI​

  1. On the pipelines page of BeetleboxCI in your browser: If you do not already have any pipelines in BeetleboxCI, click 'Create your first pipeline'. Otherwise, click "Create Pipeline" at the bottom of the pipelines page.
  2. In the following screen, fill in the following:

  • Project Name: [Name of your Github repository]

  • Repository URL: https://github.com/<username>/<repo_name>.git

    The authentication settings can be left blank since they are not necessary when adding a public repository.

  1. Click proceed. You will now be redirected to the pipelines page where you can see the project that you just created.

Adding a Private Github Repository to BeetleboxCI​

When you add a project from a private repository to BeetleboxCI, you will need to provide either:

  • A Github username and personal access token (https authentication)
  • A private SSH key to BeetleboxCI (plus adding the public key as a deploy key to the Github repository)

You can find more information further down this page about how to create personal access tokens and set up SSH keys.

  1. On the pipelines page of BeetleboxCI in your browser: If you do not already have any pipelines in BeetleboxCI, click 'Create your first pipeline'. Otherwise, click "Create Pipeline" at the bottom of the pipelines page.
  2. In the following screen, fill in the following:
  • Project Name: [Name of your Github repository]
  • Repository URL: https://github.com/<username>/<repo_name>.git or git@github.com:<username>/<repo_name>.git
  1. Also fill in either the "Authentication settings" section OR the "SSH Authentication" section. You will need need to use username and token authentication if you chose the https URL or SSH authentication if you chose the SSH URL.
  • Authentication Settings — Username: <Github username>
  • Authentication Settings — Password: <Github personal access token>
  • SSH Authentication — SSH private key
  1. Click proceed. You will now be redirected to the pipelines page where you can see the project that you just created.

Create a Github Personal Access Token​

To generate a personal access token for Github, you can follow this link. This personal access token can be used when creating pipelines in BeetleboxCI. When creating the token, you can specify the exact permissions this token will have.

SSH Keys​

Generate an SSH Key​

As an alternative to your username and a personal access token, you can generate an SSH key to authenticate access to private git repositories (given that the public key is added either to your Github account or just as a deploy key to the repository).

These commands are identical for both Windows and Linux.

  1. Open a terminal in Linux or Powershell in Windows.

  2. Input the command below, replacing the email address with the email that you have registered on Github:

    ssh-keygen -t ed25519 -C "your_email@example.com"
  1. You will be prompted to enter a location to save the key. Press Enter to accept the default location which is shown.
  2. When prompted, enter a secure passphrase.
  3. Now two files will have been generated, and you can browse to the location where you saved them in Step 3 to find them. The file ending in .pub contains the public key which will need to be added as a deploy key either to you Github account or just to a Github repository. The private key can be added during the pipeline creation process in BeetleboxCI, as a means of authentication.

More information generating SSH keys for Github can be found on this link.

Add a public key (deploy key) to a Github repository​

This will provide authentication for just this repository.

  1. Browse to the repository which you want to add the key to.

  2. Click settings (if the settings option is not visible, then you do not have permissions to edit the settings of the repository)

  3. In the left-hand sidebar, click Deploy keys.

  4. Click Add deploy key on the top right.

  5. Choose a title for the deploy key that helps to remember what it is for, and paste the public key from the file you generated earlier.

    The public key will be similar to:

    ssh-ed25529 M3AGUEr7YVcArc00zSx3WWfY0Kxkb4tNL3BE8020XRwcrE6MBtUXQsKHab3rZt4qSEF62Z user@example.com

  6. You can optionally choose to allow write access, which will allow BeetleboxCI to perform pushes to the repository (at present, BeetleboxCI does not modify anything in your repository, but in future functionality of BeetleboxCI will be able to do this)

  7. Click Add key.

More information can be found in the deploy keys section of this document.

Add a public key to your Github account​

This will allow access to all the repositories which your account is able to access.

  1. Log in to Github

  2. In the top right hand corner of the web page, click your profile photo to show the drop-down menu and select the settings option.

  3. Click SSH and GPG keys on the left hand sidebar.

  4. Click New SSH key

  5. Provide a title for the key, and choose the Key type as Authentication key.

  6. Paste the public key into the Key field.

    The public key will be similar to:

    ssh-ed25529 M3AGUEr7YVcArc00zSx3WWfY0Kxkb4tNL3BE8020XRwcrE6MBtUXQsKHab3rZt4qSEF62Z user@example.com

  7. Click Add SSH key.

  8. If prompted, enter your Github username and password.

More information about adding SSH keys to your account can be found this this document.