VIPR Authentication Setup

This guide covers creating a Personal Access Token for accessing VIPR repositories and Docker registry.

When You Need Authentication

You need a Personal Access Token to:

  • Install VIPR Core via pip from GitLab

  • Clone VIPR repositories from GitLab

  • Pull Docker images from the HZDR registry

Step 1: Create Personal Access Token

1.2 Configure Token

Create a new Personal Access Token with the following settings:

  • Token name: Choose a descriptive name (e.g., “VIPR Access”)

  • Expiration date: Set according to your needs

  • Scopes: Select the following permissions:

    • ✅ read_repository - Required for pip install and git clone

    • ✅ read_registry - Required for Docker image pulls

Token Settings

1.3 Save Token Value

After creating the token, copy and save the token value immediately. You won’t be able to see it again!

⚠️ Security Note: Treat this token like a password. Never commit it to git or share it publicly.

Step 2: Find Your Username

Your username is needed along with the token for authentication.

Find it here:

  1. Visit codebase.helmholtz.cloud

  2. Look at the top-right profile section

Username Location

Your username format is typically: @firstname.lastname

Usage Examples

Git Clone / Pip Install

When prompted for credentials:

Username for 'https://codebase.helmholtz.cloud': @your.username
Password for 'https://@your.username@codebase.helmholtz.cloud': <paste-token-here>

Example:

pip install git+https://codebase.helmholtz.cloud/vipr/vipr-core.git
Username for 'https://codebase.helmholtz.cloud': @sascha.creutzburg
Password: glpat-xxxxxxxxxxxxxxxxxxxx

Docker Registry Login

docker login registry.hzdr.de
Username: @your.username
Password: <paste-token-here>

Example:

docker login registry.hzdr.de
Username: @sascha.creutzburg
Password: glpat-xxxxxxxxxxxxxxxxxxxx
Login Succeeded