Skip to content

About

The Phorge API: tenants, images, instances, memberships and API keys on top of the phorge.fr kinds

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

phorge-api

The Phorge API: authenticated users and API keys manage tenants, images, instances, memberships and API keys. It creates phorge.fr objects on the control cluster; Crossplane turns them into Incus and OpenFGA objects.

Build and run

make vet lint test build
OIDC_ISSUER=... OIDC_AUDIENCE=... OPENFGA_URL=... OPENFGA_API_KEY=... OPENFGA_STORE_ID=... ./bin/phorge-api

The configuration is read from the environment; the process refuses to start and lists everything wrong if a required value is missing. See Configuration.

Documentation

Pages are in docs/, grouped by what you want to do: how-to guides, reference, explanation.

The kinds the API manages and the platform behind them are documented in phorge-fr/Hangar: Phorge API kinds.

Contributing

Every change starts from an issue and goes through a pull request; the rules (issue link, label, milestone, assignee, reviewer) are in the organization's GOVERNANCE and CONTRIBUTING. Planned work is on the public Roadmap. Everyone taking part follows the Code of Conduct.

Security

Report vulnerabilities privately, as described in the security policy. Do not open a public issue for them.

License

Licensed under the Apache License 2.0.

About

The Phorge API: tenants, images, instances, memberships and API keys on top of the phorge.fr kinds

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages