Get Started

Learn how to start with Tenki and smoothly migrate your workflows to our runners.

1

Create your Tenki Account

To get started, head to the Registration Page. From there, you'll create your account and first Workspace and Project:

AccountCreation

2

Install the Tenki GitHub App

Once your onboarding completed you'll get redirected to the Workspace Dashboard. From there select your project:

WorkspaceDashboard

Click the Connect GitHub button to install the Tenki GitHub App. We’ll then show you which of your Tenki workspaces are connected to your GitHub Organizations, you can click on Continue.

Important

Each Tenki workspace can be connected to only one GitHub Organization.

ConnectGithub

You will require to grants the necessary permissions for Tenki on your Organization:

TenkiGithubInstall2

Next, you’ll choose which GitHub repositories to connect to this Tenki project. You can update these selections later in the Project settings:

ProjectReposLink

3

Use our Runners: Migration Wizard (Recommended)

To make it super easy to start using our Runners—or to migrate from another solution—we’ve built a Migration Wizard. We highly recommend using it! Click on the following button:

Tenki Runners Overview

From there, select your repository. We’ll automatically detect the runners you’re currently using. All you need to do is choose the Tenki Runner you want to switch to. Once selected, you can generate the pull request and click to view it:

MigrationWizard1 MigrationWizard2

Once you’ve reviewed your pull request, go ahead and merge it—you’ll then see your first workflows running on Tenki Runners 🎊 MigrationWizard2 MigrationWizard2

4

Use our Runners: Manual Migration

GitHub Actions use the runs-on field in workflow files (located in .github/workflows) to determine which runner to use.

To switch to a Tenki runner, replace the existing runner tag with a Tenki runner tag — no other changes needed:

jobs:
  build:
-    runs-on: ubuntu-latest
+    runs-on: tenki-standard-small-2c-2g

Tenki runners are offered in 2, 4, 8 and 16 vCPU configurations:

Instance TypeComputeMemory
tenki-standard-small-2c-4g2 vCPU4 GB
tenki-standard-medium-4c-8g4 vCPU8 GB
tenki-standard-large-8c-16g8 vCPU16 GB
tenki-standard-large-plus-16c-32g16 vCPU32 GB

To simplify integration, we’ve added a dedicated view on the Runners page where you can easily copy the runner tag and paste it directly into your workflow file.


Troubleshooting

Not seeing your organization in the Tenki dashboard? Here are a few things to check:

  • The Tenki GitHub App isn't installed on your organization. Make sure it's properly added.
  • Your GitHub user isn't a member of the organization. Double-check your access.
  • Make sure you're pushing into a repositories that's actually link to your Tenki project.

Still stuck? Reach out to us at [email protected] and we'll be happy to help.

On this page