blob: a6ef288fb49cf7e9540e44c1ae99bc039baee403 [file]
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# Sample environment file for the Custos backend.
# Copy to .env, fill in real values, and `source .env` (or use a dotenv loader).
# The portal has its own env template at web/.env.example.
# --- Server: required ----------------------------------------------------
# MySQL/MariaDB DSN. Must allow multi-statements for migrations.
DATABASE_DSN=admin:admin@tcp(localhost:3306)/custos?parseTime=true&charset=utf8mb4&multiStatements=true
# OIDC issuer + audience. Server refuses to start without these.
#
# Defaults point at the bundled Keycloak from dev-ops/compose:
# docker compose up -d keycloak
# Realm import: dev-ops/compose/keycloak/import/custos-realm.json
#
# For any external OIDC provider, register a client with redirect
# http://localhost:3000/api/auth/callback/oidc and replace both values with
# your provider's issuer URL and the access-token `aud` claim (typically the client_id).
OIDC_ISSUER_URL=http://localhost:8081/realms/custos
OIDC_AUDIENCE=custos-api
# --- Server: dev convenience ---------------------------------------------
# UUID of the compute cluster this Custos instance serves.
# Shared across connectors that need to know which cluster they belong to.
CUSTOS_CLUSTER_ID=00000000-0000-0000-0000-000000000001
# Grants super_admin to the user with this email on first boot. Idempotent.
# Bundled Keycloak: keep the default (matches the seeded realm user).
# External OIDC: use your own email. A PENDING super_admin user is created
# and your first sign-in links your OIDC sub to it via email fallback.
CUSTOS_BOOTSTRAP_ADMIN_EMAIL=admin@custos.local
# --- AMIE connector (ACCESS-CI) ------------------------------------------
AMIE_BASE_URL=http://localhost:8180
AMIE_SITE_CODE=TESTSITE
AMIE_API_KEY=dev
AMIE_CLUSTER_ID=00000000-0000-0000-0000-000000000001
# --- COmanage connector --------------------------------------------------
COMANAGE_REGISTRY_URL=
COMANAGE_CO_ID=
COMANAGE_API_USER=
COMANAGE_API_KEY=
COMANAGE_UNIX_CLUSTER_ID=
COMANAGE_PERSON_ID_TYPE=
# --- SLURM connector -----------------------------------------------------
SLURM_API=
SLURM_USER=
SLURM_TOKEN=
SLURM_API_VERSION=
# Used only by the Usage-Monitor connector.
SLURM_MONITOR_CLUSTER_ID=