ClusterCockpit/cc-backend
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-backend synced 2024-12-26 13:29:05 +01:00
Code Issues Packages Releases Activity

Update README.md

Browse Source
This commit is contained in:
Jan Eitzinger 2022-09-16 07:05:44 +02:00 committed by GitHub
parent ae26c86e3b
commit 597fe955fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -112,12 +112,12 @@ If you start cc-backend with flag `--dev` the Swagger UI is available at http://
- `api/` contains the API schema files for the REST and GraphQL APIs. The REST API is documented in the OpenAPI 3.0 format in [./api/openapi.yaml](./api/openapi.yaml). - `api/` contains the API schema files for the REST and GraphQL APIs. The REST API is documented in the OpenAPI 3.0 format in [./api/openapi.yaml](./api/openapi.yaml).
- `cmd/cc-backend` contains `main.go` for the main application. - `cmd/cc-backend` contains `main.go` for the main application.
- `cmd/gen-keypair` contains is a small application to generate a compatible JWT keypair includin a README about JWT setup in ClusterCockpit.
- `configs/` contains documentation about configuration and command line options and required environment variables. An example configuration file is provided. - `configs/` contains documentation about configuration and command line options and required environment variables. An example configuration file is provided.
- `init/` contains an example systemd setup for production use. - `init/` contains an example systemd setup for production use.
- `internal/` contains library source code that is not intended to be used by others. - `internal/` contains library source code that is not intended to be used by others.
- `pkg/` contains go packages that can also be used by other projects. - `pkg/` contains go packages that can also be used by other projects.
- `test/` Test apps and test data. - `test/` Test apps and test data.
- `tools/` contains supporting tools for cc-backend. At the moment this is a small application to generate a compatible JWT keypair includin a README about JWT setup in ClusterCockpit.
- `web/` Server side templates and frontend related files: - `web/` Server side templates and frontend related files:
- `templates` Serverside go templates - `templates` Serverside go templates
- `frontend` Svelte components and static assets for frontend UI - `frontend` Svelte components and static assets for frontend UI