recipe-maintainers/recipe-maintainer
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
460eba090ba6765b05a929d32d16ca984cf66e5a
recipe-maintainer/recipe-info/README.md
autonomic-bot f283a371bb recipe-maintainer: public snapshot (secrets + deployment plans removed, single commit) 
Sanitized single-commit public mirror of recipe-maintainer.
- Removed test-ssh/.testenv (live creds); added test-ssh/.testenv.example placeholders.
- Removed plans/ and planned-updates/ (deployment-planning docs) so no client/
  deployment domains appear in the public repo.
- All other secret stores were already gitignored.
- docs.coopcloud.tech retained as a submodule (public upstream).
2026-06-16 20:18:24 +00:00

2.0 KiB
Raw Blame History

Recipe Info

Each recipe has its own subdirectory under recipe-info/ containing upstream information, setup instructions, tests, and other recipe-specific documentation.

Directory Structure

recipe-info/
  README.md                # This file
  testsecrets/             # Synced Docker secrets from test server (gitignored)
  <recipe-name>/
    recipe.toml            # Recipe metadata (domain, instance, dependencies)
    upstream.md            # Upstream project links, release notes URLs
    setup.md               # Setup and deployment instructions
    test.md                # What to test and how to verify
    tests/
      health_check.py      # Basic health/reachability check
      *.py                 # Additional Python test scripts

Some recipes also have SSO integration scripts (setup_*_integration.py) and credential files (gitignored).

Recipes

Recipe Directory
Authentik recipe-info/authentik/
Bluesky PDS recipe-info/bluesky-pds/
CryptPad recipe-info/cryptpad/
HedgeDoc recipe-info/hedgedoc/
Immich recipe-info/immich/
Keycloak recipe-info/keycloak/
La Suite Docs recipe-info/lasuite-docs/
La Suite Drive recipe-info/lasuite-drive/
La Suite Meet recipe-info/lasuite-meet/
Matrix Synapse recipe-info/matrix-synapse/
Mumble recipe-info/mumble/

How to Use

  1. Navigate to the recipe's directory.
  2. Check recipe.toml for recipe metadata (domain, instance name, dependencies).
  3. Check upstream.md for upstream project links and release notes URLs.
  4. Read setup.md for deployment and configuration instructions.
  5. Read test.md for an overview of what to verify and expected behaviour.
  6. Run tests via the test runner: python scripts/test_runner.py <recipe-name>.