DocumentaciónHelp

Import keys

Create a key so your product's repository uploads its documentation to a knowledge space, store it as a secret, rotate it or revoke it.

On this page

An import key lets your product's repository (for example, on GitHub) upload its documentation folder to a Knowledge space on every change, without anyone signing in to Elion ITSM. Each key works for one space only.

Before you start

  • You need the administrator level in Settings (Administrator role).

  • The help center must be activated. Read Activate the help center.

  • The Knowledge space you will import into must exist. It can have any visibility; to be shown in the help center, it must be Public and included.

  • You need permission to add secrets in the repository.

Create a key

  1. Go to Settings → Help center and open the Import tab.

  2. In the Import keys card, choose the space in Space. The list shows the spaces included in the help center first.

  3. Click Create key.

  4. In New key for…, fill in:

    Field

    What to enter

    Name

    Something to recognize it later, for example the repository: "Manuals GitHub Action".

    Expires

    In 90 days, In 180 days, In one year (the default option) or No expiry.

  5. Click Create key.

The Key created window opens with the full key. It starts with ul_kb_.

  1. Click Copy key.

  2. Paste it right away into the repository secret (see below).

  3. Click Done, I copied it.

The key is shown only once. After you close the window you cannot see it again: the list keeps only its beginning, like ul_kb_a1b2c3d4e5f6_…. If you lose it, rotate it. Do not write it in the YAML, in the code or in a message.

Each space allows up to 5 active keys. If you reach the limit, you see The space already has 5 active keys: revoke one before creating another.

Store the key in the repository

On GitHub:

  1. In the repository, go to Settings → Secrets and variables → Actions.

  2. Click New repository secret.

  3. For the name, enter ARGUNIS_KB_IMPORT_KEY.

  4. For the value, paste the key.

  5. Save the secret.

The GitHub Action

The GitHub Action card has the file ready to copy, with the exact Elion ITSM address. Click Copy YAML and save it in the repository as .github/workflows/argunis-itsm-docs.yml.

On every change to the main branch that touches the docs/usabilidad folder, the Action compresses that folder and uploads it to Elion ITSM with the key from the secret. You can also run it manually from the Actions tab on GitHub.

The file looks like this (always copy the one on screen, which has your Elion ITSM address):

name: Documentación a Elion ITSM

on:
  push:
    branches: [main]
    paths: ['docs/usabilidad/**']
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: argunis-itsm-kb-import
  cancel-in-progress: false

jobs:
  importar:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v5

      - name: Comprimir docs/usabilidad
        run: cd docs/usabilidad && zip -qr "$RUNNER_TEMP/docs.zip" .

      - name: Subir a Elion ITSM
        env:
          ARGUNIS_KB_IMPORT_KEY: ${{ secrets.ARGUNIS_KB_IMPORT_KEY }}
        run: |
          curl --fail-with-body -sS -X POST \
            -H "Authorization: Bearer $ARGUNIS_KB_IMPORT_KEY" \
            -F "file=@$RUNNER_TEMP/docs.zip;type=application/zip" \
            "https://api-itsm.argunis.com/api/kb/import?ref=$GITHUB_SHA"

How to prepare the docs/usabilidad folder is explained in Import documentation from a repository.

The key list

The table shows the keys of the chosen space:

Column

What it shows

Name

The name, who created it and when.

Key

The beginning of the key, so you can recognize it.

Status

active, expired or revoked. A rotated key also says rotated: stops working when it expires.

Last used

When it was last used, or never.

Expires

The expiry date, or no expiry.

Rotate a key

Rotate a key when you lost it, when someone who knew it left the team or before it expires. Rotation does not interrupt imports.

  1. Click Rotate on the key.

  2. Confirm with Rotate.

  3. In New key for “…”, click Copy key and replace the value of the ARGUNIS_KB_IMPORT_KEY secret in the repository.

  4. Click Done, I copied it.

The new key keeps the name, space and duration. The previous one keeps working for 24 hours, so you have time to change the secret; after that it stops working.

Revoke a key

  1. Click Revoke on the key.

  2. Confirm with Revoke.

You see Key revoked. It stops working immediately: the next import with that key is rejected. Revoking cannot be undone; if you need it again, create a new one.

Related

Search Elion ITSM

Type at least 2 characters to search Elion ITSM.

↑↓ to navigate · Enter to open · Esc to close