{"id":20126435,"url":"https://github.com/sovereigncloudstack/status-page-api","last_synced_at":"2025-05-06T17:35:16.273Z","repository":{"id":103212952,"uuid":"548922870","full_name":"SovereignCloudStack/status-page-api","owner":"SovereignCloudStack","description":"status page api server","archived":false,"fork":false,"pushed_at":"2025-03-13T01:25:12.000Z","size":272,"stargazers_count":5,"open_issues_count":5,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-09T15:29:14.776Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://scs.community/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SovereignCloudStack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-10T11:54:35.000Z","updated_at":"2024-11-22T14:07:33.000Z","dependencies_parsed_at":"2023-11-16T12:27:11.687Z","dependency_job_id":"463c26ad-0bba-450d-96f6-378a01f7b4de","html_url":"https://github.com/SovereignCloudStack/status-page-api","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SovereignCloudStack%2Fstatus-page-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SovereignCloudStack%2Fstatus-page-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SovereignCloudStack%2Fstatus-page-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SovereignCloudStack%2Fstatus-page-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SovereignCloudStack","download_url":"https://codeload.github.com/SovereignCloudStack/status-page-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252734487,"owners_count":21796029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T20:16:07.666Z","updated_at":"2025-05-06T17:35:15.960Z","avatar_url":"https://github.com/SovereignCloudStack.png","language":"Go","readme":"# Status Page API\n\nThe server handles components, incidents and other resources according to the [Open API spec for status page](https://github.com/SovereignCloudStack/status-page-openapi).\n\n## Config\n\nThe service can be configured by  either providing flags to the binary or via environment variables.\n\n### Examples\n\nChangeing the listining address to `localhost:3001`.\n\n#### Flags\n\n```bash\n./bin/status-page-api --server-listen-address :3001\n```\n\n#### Environment\n\nEvery config key is prefixed by `STATUS_PAGE`.\n\n```bash\nSTATUS_PAGE_SERVER_LISTEN_ADDRESS=:3001 ./bin/status-page-api\n```\n\n### Verbosity\n\nDefault logging level is set to `WARN` level and can be increased by adding `-v` to the binary, to a maximum of `-vvv` being the `TRACE` level.\n\nSetting verbosity by environment variables requires setting it to a number.\n\n```env\n# INFO level\nSTATUS_PAGE_VERBOSE=1\n# DEBUG level\nSTATUS_PAGE_VERBOSE=2\n# TRACE level\nSTATUS_PAGE_VERBOSE=3\n```\n\n## Development settings\n\nCreate `secrets.env` for config:\n\n```env\nSTATUS_PAGE_VERBOSE=3\nSTATUS_PAGE_SWAGGER_UI_ENABLED=true\nSTATUS_PAGE_SERVER_LISTEN_ADDRESS=:3000\nSTATUS_PAGE_SERVER_CORS_ORIGINS=\"localhost 127.0.0.1\"\nSTATUS_PAGE_DATABASE_CONNECTION_STRING=\"host=127.0.0.1 user=postgres dbname=postgres port=5432 password=debug sslmode=disable\"\nSTATUS_PAGE_PROVISIONING_FILE=./provisioning.yaml\n```\n\n`STATUS_PAGE_SERVER_SWAGGER_UI_ENABLED` enables the [Swagger Web UI](https://swagger.io/tools/swagger-ui/) for local debugging purposes, which is disabled by default.\n\n`STATUS_PAGE_METRICS_ADDRESS=:9000` enables the `/metrics` endpoint on the configured port for Prometheus scraping.\n\n### Note\n\nSource the env before executing the binary, to configure the service.\n\nThe `Makefile` target `make serve` sources the env file `secrets.env` by default.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsovereigncloudstack%2Fstatus-page-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsovereigncloudstack%2Fstatus-page-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsovereigncloudstack%2Fstatus-page-api/lists"}