{"id":13419664,"url":"https://github.com/jayfk/statuspage","last_synced_at":"2025-05-14T09:07:46.635Z","repository":{"id":41284413,"uuid":"52598117","full_name":"jayfk/statuspage","owner":"jayfk","description":"A statuspage generator that lets you host your statuspage for free on Github.","archived":false,"fork":false,"pushed_at":"2022-11-15T03:21:27.000Z","size":1703,"stargazers_count":3894,"open_issues_count":37,"forks_count":183,"subscribers_count":38,"default_branch":"master","last_synced_at":"2025-04-03T16:07:47.443Z","etag":null,"topics":["generator","monitoring","statuspage"],"latest_commit_sha":null,"homepage":"https://corestatus.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jayfk.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-26T10:47:27.000Z","updated_at":"2025-03-30T22:57:57.000Z","dependencies_parsed_at":"2023-01-22T10:30:10.705Z","dependency_job_id":null,"html_url":"https://github.com/jayfk/statuspage","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayfk%2Fstatuspage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayfk%2Fstatuspage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayfk%2Fstatuspage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jayfk%2Fstatuspage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jayfk","download_url":"https://codeload.github.com/jayfk/statuspage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248330633,"owners_count":21085748,"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":["generator","monitoring","statuspage"],"created_at":"2024-07-30T22:01:19.122Z","updated_at":"2025-04-11T02:38:16.148Z","avatar_url":"https://github.com/jayfk.png","language":"Python","funding_links":[],"categories":["Python","Opensource","monitoring","Tools"],"sub_categories":["Python"],"readme":"*We are currently alpha-testing a fully automated statuspage GitHub app. Check out [corestatus.io](https://corestatus.io/) if you like to test it out.*\n\n# Statuspage\n\n[![ci](https://github.com/jayfk/statuspage/actions/workflows/ci.yml/badge.svg)](https://github.com/jayfk/statuspage/actions/workflows/ci.yml)\n[![codecov.io](https://codecov.io/github/jayfk/statuspage/coverage.svg?branch=master)](https://codecov.io/github/jayfk/statuspage?branch=master)\n\nA statuspage generator that lets you host your statuspage for free on GitHub. Uses\nissues to display incidents and labels for severity.\n\n## Demo\n\n![DEMO](https://github.com/jayfk/statuspage/blob/master/demo.gif)\n\nSee a real status page generated by this here [demo site](https://jayfk.github.io/statuspage-demo/)\n\n## Quickstart\n\nInstall statuspage with pip:\n\n    pip install statuspage\n\n*There are also binaries for macOS and Linux available, see [installation](docs/installation.md) for more.*\n\nNow, create an GitHub API token:\n\n- Go to your [Personal Access tokens](https://github.com/settings/tokens) page.\n- Click on `Generate new token`.\n- Make sure to check the `public_repo` and `write:repo_hook` scope.\n- Copy the token somewhere safe, you won't be able to see it again once you leave the page.\n\nTo create a new status page, run:\n\n    statuspage create --token=\u003cyourtoken\u003e\n\nYou'll be prompted for a repo name and the systems you want to show a status for.\n\n    Name: mystatuspage\n    Systems, eg (Website,API): Website, CDN, API\n\n*Please note: This will generate a new repo under that name. Make sure it doesn't exist already.*\n\nThe command takes a couple of seconds to run. Once ready, it will output links to the issue tracker and your new status page.\n\n    Create new issues at https://github.com/\u003clogin\u003e/mystatuspage/issues\n    Visit your new status page at https://\u003clogin\u003e.github.com/mystatuspage/\n\nThe generator will then print the `statuspage update` command filled with all the details you need to update your page.\n\n## Create an issue\n\nTo create a new issue, go to your newly created repo and click on `New Issue`.\n\n- Click on the cog icon next to labels on the right.\n- Choose the affected systems (black labels)\n- Choose a severity label (major outage, degraded performance, investigating)\n- Fill in the title, leave a comment and click on `Submit new issue`.\n\n![Add New Issue](docs/new_issue.png)\n\nNow, update your status page. Go back to your commandline and type:\n\n    statuspage update --token=\u003cyourtoken\u003e\n    Name: mystatuspage\n\nIf you change the issue (eg. when you add a new label, create a comment or close the issue), you'll\nneed to run `statuspage update` again.\n\n## Adding and removing systems\n\nIn order to add or remove a system, run:\n\n    statuspage add_system --token=\u003ctoken\u003e --name=\u003crepo\u003e --system=\u003csystem to add\u003e\n    statuspage remove_system --token=\u003ctoken\u003e --name=\u003crepo\u003e --system=\u003csystem to remove\u003e\n\n## Upgrading from previous versions\n\nFirst, install the latest version with pip, or grab the latest [binary](docs/installation.md):\n\n    pip install statuspage --upgrade\n\nUpdating your page to the latest version is now as simple as running:\n\n    statuspage upgrade --token=\u003ctoken\u003e --name=\u003crepo\u003e\n\nfollowed by an update:\n\n    statuspage update --token=\u003ctoken\u003e --name=\u003crepo\u003e\n\n## Translations\nThe generated status page is translated via JavaScript on the client side using [webL10n](https://github.com/fabi1cazenave/webL10n). It detects the visitors preferred language and translates all strings automatically.\n\nTranslations are available for the following languages:\n\n- en\n- bg\n- de\n- kr\n- nl\n- pt\n- es\n- ru\n- fr\n- pl\n- zh-HK\n- zh-TW\n- zh-CN\n- it\n- fur\n- vn\n\nWant to add a translation? Open `translations.ini` and add it. Pull requests welcome!\n\n## Customizing\nWant to change styles, the logo, or the footer? Check out [customizing](docs/customizing.md).\n\n## Options\n\nWant to create a status page for an organisation, or a private one? See [options](docs/options.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjayfk%2Fstatuspage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjayfk%2Fstatuspage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjayfk%2Fstatuspage/lists"}