Installation

Uchi can be installed as a gem directly from our private gem server.

Note

Installing Uchi requires a license with a gem server token for that project. Licenses can be purchased at uchiadmin.com and the gem server token can be found on uchiadmin.com/projects.

Authenticate with the gem server

You have a few options for authentication with the gem server. We recommend using an ENV variable configured for each project.

Using an ENV variable

BUNDLE_GEMS__UCHIADMIN__COM=<your_token_goes_here>

The benefit of this is that it works across your deployments - ie both development, CI, and production are likely to have support for ENV variables.

Warning

You cannot store the variable in .env or similar and expect dotenv to load it for you. dotenv isn’t loaded by bundler thus the ENV variable isn’t available when installing.

Using Bundler config

Alternatively, if you have just one project with Uchi, you can configure the gem server token in your bundler installation:

bundle config set --global gems.uchiadmin.com <your_token_goes_here>

This way it’s always available to bundler.

Install the gem

Add the gem to your application’s Gemfile:

gem "uchi", source: "https://gems.uchiadmin.com"

And then execute:

$ bundle install

Authenticate and install on CI servers

GitHub Actions

On GitHub Actions you can add environment variables to your workflows fairly easily. However, you should treat your private gem server token as a secret, and therefore not expose it publicly. So for this we want to use GitHub Secrets.

Under your project’s “Settings” in GitHub, go to “Secrets and variables” > “Actions” in the menu.
Add a “New repository secret”
Use BUNDLE_GEMS__UCHIADMIN__COM as the name of the secret and paste your gem server token into the secret.
Click “Add secret”

Now you can use that secret in your workflows:

name: "Build"

env:
  BUNDLE_GEMS__UCHIADMIN__COM: ${{ secrets.BUNDLE_GEMS__UCHIADMIN__COM }}

jobs:
  # ...

Read more about using secrets in workflows.