Omgevingsvariabelen
1 min leestijd
Omgevingsvariabelen hebben voorrang boven het inloggegevensbestand. Ze zijn de aanbevolen manier om te authenticeren in CI/CD-pijplijnen en geautomatiseerde omgevingen.
Ondersteunde Variabelen
| Variabele | Beschrijving | Standaard |
|---|---|---|
OPENCX_API_KEY | API-token voor authenticatie. Wanneer ingesteld, wordt het inloggegevensbestand genegeerd. | -- |
OPENCX_API_URL | Basis-URL van de OpenCX API. Alleen gebruikt wanneer OPENCX_API_KEY ook is ingesteld. | "https://api.open.cx" |
Wanneer Omgevingsvariabelen te Gebruiken
- CI/CD-pijplijnen -- stel
OPENCX_API_KEYin als een geheim in je CI-provider. - Docker-containers -- geef de sleutel door tijdens runtime in plaats van inloggegevens in de afbeelding te bakken.
- Meerdere omgevingen -- schakel tussen staging en productie door
OPENCX_API_URLte wijzigen.
CI/CD Voorbeeld
yaml
# GitHub Actions
steps:
- name: Push content
run: opencx content push
env:
OPENCX_API_KEY: ${{ secrets.OPENCX_API_KEY }}
yaml
# GitLab CI
push_content:
script:
- opencx content push
variables:
OPENCX_API_KEY: $OPENCX_API_KEY
Notities
OPENCX_API_URLheeft geen effect tenzijOPENCX_API_KEYook is ingesteld. De URL uitopencx.jsonwordt onafhankelijk gebruikt voor projectniveauconfiguratie.- Als er geen omgevingsvariabelen of een inloggegevensbestand worden gevonden, stopt de CLI met een foutmelding waarin je wordt gevraagd
opencx auth loginuit te voeren.