# Authentication

Most VIPR packages are publicly available and do **not** require authentication:

| Package | Availability |
|---|---|
| `vipr-core` | Public (GitHub / PyPI) |
| `vipr-framework` | Public (GitHub) |
| `vipr-frontend` | Public (GitHub) |
| `vipr-reflectometry-plugin` | Public (GitHub) |
| `vipr-helm-chart` | Public (GitHub) |
| `vipr-gid-plugin` | **Private** — HZDR GitLab only |

## vipr-gid-plugin (private)

The `vipr-gid-plugin` is hosted on [codebase.helmholtz.cloud](https://codebase.helmholtz.cloud) and is not publicly accessible. Access requires a **Personal Access Token** from the HZDR GitLab instance.

### Create a Personal Access Token

1. Visit [User Settings → Personal Access Tokens](https://codebase.helmholtz.cloud/-/user_settings/personal_access_tokens)
2. Create a new token with at minimum the `read_repository` scope
3. Copy and store the token value immediately — it will not be shown again

### Install with pip

```bash
pip install git+https://@your.username:glpat-xxxx@codebase.helmholtz.cloud/vipr/vipr-gid-plugin.git
```

Or when prompted interactively:

```bash
pip install git+https://codebase.helmholtz.cloud/vipr/vipr-gid-plugin.git
Username: @your.username
Password: glpat-xxxxxxxxxxxxxxxxxxxx
```

> **Security note:** Treat the token like a password. Never commit it to version control or share it publicly.