env

Name: env
Author: NatoBoram

This file is meant to be committed and public. It documents the default values of environment variables that are prone to getting changed locally. It serves as a template for the secrets stored in `.e

by NatoBoram(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from NatoBoram/docker-compose (.github/instructions/env.instructions.md). Copyright stays with the author.

applyTo: /.env,/.env.!(local),**/.env.*.!(local)

For environment variables that are not changing or not secrets, they should be directly put into the service's compose.yaml.

For example:

services:
	authentik-server:
		env_file:
			- .env.authentik-server
			- .env.authentik-server.local
		environment:
			AUTHENTIK_POSTGRESQL__HOST: authentik-postgres
			AUTHENTIK_POSTGRESQL__NAME: authentik
			AUTHENTIK_POSTGRESQL__USER: authentik

AUTHENTIK_POSTGRESQL__PASSWORD=
AUTHENTIK_SECRET_KEY=

Each individual service should have its own .env.* files. Do not share .env files between services even if they have the same key and value.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/natoboram-docker-compose-env-instructions/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

natoboram-docker-compose-env-instructions.ocm.jsonjson

{
  "ocm": "1",
  "id": "natoboram-docker-compose-env-instructions",
  "kind": "skill",
  "name": "env",
  "description": "This file is meant to be committed and public. It documents the default values of environment variables that are prone to getting changed locally. It serves as a template for the secrets stored in `.env.local` files.",
  "publisher": "NatoBoram",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "This file is meant to be committed and public. It documents the default values of environment variables that are prone to getting changed locally. It serves as a template for the secrets stored in `.env.local` files."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/NatoBoram/docker-compose",
      "path": ".github/instructions/env.instructions.md",
      "ref": "d3dd936a7c5e9d96f07ab9e672bb477b85c80af5",
      "url": "https://github.com/NatoBoram/docker-compose/blob/d3dd936a7c5e9d96f07ab9e672bb477b85c80af5/.github/instructions/env.instructions.md",
      "key": "NatoBoram/docker-compose/.github/instructions/env.instructions.md"
    }
  },
  "instructions": "---\napplyTo: **/.env,**/.env.!(local),**/.env.*.!(local)\n---\n\nThis file is meant to be committed and public. It documents the default values of environment variables that are prone to getting changed locally. It serves as a template for the secrets stored in `.env.local` files.\n\nFor environment variables that are not changing or not secrets, they should be directly put into the service's `compose.yaml`.\n\nFor example:\n\n```yaml\nservices:\n\tauthentik-server:\n\t\tenv_file:\n\t\t\t- .env.authentik-server\n\t\t\t- .env.authentik-server.local\n\t\tenvironment:\n\t\t\tAUTHENTIK_POSTGRESQL__HOST: authentik-postgres\n\t\t\tA",
  "cost": {
    "context_tokens": 223
  }
}

Fetch it by URL: GET /api/v1/registry/natoboram-docker-compose-env-instructions/manifest?version=1.0.0

About

applyTo: /.env,/.env.!(local),**/.env.*.!(local)

Use it

Manifest

Reviews