|
|
A "status" dashboard is a simple website that allows service admins to
|
|
|
clearly and simply announce downtimes and recovery.
|
|
|
clearly and simply announce down times and recovery.
|
|
|
|
|
|
Note that this be considered part of the [documentation](service/documentation) system,
|
|
|
but is documented separately.
|
... | ... | @@ -40,7 +40,7 @@ Issues are in `content/issues`. TODO: Expand. |
|
|
|
|
|
The `status.torproject.org` site currently lives in the [static mirror
|
|
|
system](howto/static-component) and uses the [git-rw repository](https://gitweb.torproject.org/project/web/status-site.git/) which get built via
|
|
|
Jenkins once you push to the repo.
|
|
|
Jenkins once you push to the repository.
|
|
|
|
|
|
In other words, uploading the site is automated by continuous
|
|
|
integration. So you simply need to commit and push:
|
... | ... | @@ -103,7 +103,7 @@ information on diagnosing those. |
|
|
It should be possible to deploy the static website anywhere that
|
|
|
supports plain HTML, assuming you have a copy of the git repository.
|
|
|
|
|
|
The instructions below asssume you have a copy of the git
|
|
|
The instructions below assume you have a copy of the git
|
|
|
repository. Make sure you follow the [installation instructions](#local-development-environment) to
|
|
|
also clone the submodules! If the git repository is not available, you
|
|
|
could start from scratch using [the example repository](https://github.com/cstate/example) as well.
|
... | ... | @@ -243,10 +243,10 @@ site](howto/static-component) and [git](howto/git) services. |
|
|
This project comes from two places:
|
|
|
|
|
|
1. during the [2020 TPA user survey](https://gitlab.torproject.org/tpo/tpa/team/-/issues/40061), some respondents suggested
|
|
|
to document "downtimes of 1h or longer" and better communicate
|
|
|
to document "down times of 1h or longer" and better communicate
|
|
|
about service statuses
|
|
|
|
|
|
2. seperately, following a major outage in the Tor network due to a
|
|
|
2. separately, following a major outage in the Tor network due to a
|
|
|
DDOS, the network team and network health teams [asked for a
|
|
|
dashboard to inform tor users about such problems in the
|
|
|
future](https://gitlab.torproject.org/tpo/tpa/team/-/issues/40138)
|
... | ... | @@ -267,14 +267,14 @@ with status updates. |
|
|
the Tor wider community of users (not just TPI/TPA)
|
|
|
* **status updates and progress**: "post status problem we know about
|
|
|
so the world can learn if problems are known to the Tor team."
|
|
|
* example: "[recent] v3 outtage where we could have put out a small
|
|
|
* example: "[recent] v3 outage where we could have put out a small
|
|
|
FAQ right away (go static HTML!) and then update the world as we
|
|
|
figure out the problem but also expected return to normal."
|
|
|
* **multi-stakeholder**: "easily editable by many of us namely likely
|
|
|
the network health team and we could also have the network team to
|
|
|
help out"
|
|
|
* **simple to deploy and use**: pushing an update shouldn't require
|
|
|
complex software or procedures. editing a text file, commiting and
|
|
|
complex software or procedures. editing a text file, committing and
|
|
|
pushing, or building with a single command and pushing the HTML,
|
|
|
for example, is simple enough. installing a MySQL database and PHP
|
|
|
server, for example, is not simple enough.
|
... | ... | @@ -322,7 +322,7 @@ somewhat in active development: |
|
|
* [demo site](https://demo.cachethq.io/) (test@test.com, test123)
|
|
|
* responsive
|
|
|
* [not decentralized](https://twitter.com/theanarcat/status/575061666532102144)
|
|
|
* [no nagios support](https://github.com/cachethq/Cachet/issues/225)
|
|
|
* [no Nagios support](https://github.com/cachethq/Cachet/issues/225)
|
|
|
* user-friendly
|
|
|
* publicly accessible
|
|
|
* fairly easy to use
|
... | ... | @@ -330,9 +330,9 @@ somewhat in active development: |
|
|
* no Twitter, Identica, IRC or XMPP support for now
|
|
|
* [dropped RSS support](https://github.com/CachetHQ/Cachet/issues/3313)
|
|
|
* future of the project uncertain ([4037](https://github.com/CachetHQ/Cachet/issues/4037), [3968](https://github.com/CachetHQ/Cachet/issues/3968))
|
|
|
* [cstate](https://github.com/cstate/cstate), hugo-based static site generator, tag-based RSS
|
|
|
* [cstate](https://github.com/cstate/cstate), Hugo-based static site generator, tag-based RSS
|
|
|
feeds, easy setup on Netlify, GitLab CI integration, badges,
|
|
|
readonly API
|
|
|
read only API
|
|
|
* [Staytus](http://staytus.co/)
|
|
|
* ruby
|
|
|
* MySQL database
|
... | ... | @@ -340,7 +340,7 @@ somewhat in active development: |
|
|
* email notifications
|
|
|
* mobile-friendly
|
|
|
* not distributed
|
|
|
* no nagios integration
|
|
|
* no Nagios integration
|
|
|
* [no Twitter notifications](https://github.com/adamcooke/staytus/issues/2)
|
|
|
* user-friendly - seems to be even nicer than Cachet, as there are links to individual announcements and notifications
|
|
|
* no LDAP support
|
... | ... | @@ -352,13 +352,13 @@ somewhat in active development: |
|
|
Those were previously evaluated in a previous life but ended up being
|
|
|
abandoned upstream:
|
|
|
|
|
|
* [Overseer](https://github.com/disqus/overseer) - used at [Disqus.com](http://disqus.com/), Python/django, user-friendly/simple, [administrator non-friendly](https://overseer.readthedocs.org/en/latest/admin.html), twitter integration, Apache2 license, development stopped, Disqus replaced it with [Statuspage.io](https://www.statuspage.io/)
|
|
|
* [Overseer](https://github.com/disqus/overseer) - used at [Disqus.com](http://disqus.com/), Python/Django, user-friendly/simple, [administrator non-friendly](https://overseer.readthedocs.org/en/latest/admin.html), twitter integration, Apache2 license, development stopped, Disqus replaced it with [Statuspage.io](https://www.statuspage.io/)
|
|
|
* [Stashboard](http://www.stashboard.org/) - used at [Twilio](http://www.twilio.com/), MIT license, [demo](http://stashboard.appspot.com/), Twitter integration,
|
|
|
REST API, abandon-ware, no authentication, no unicode support,
|
|
|
REST API, abandon-ware, no authentication, no Unicode support,
|
|
|
depends on Google App engine, requires daily updates
|
|
|
* [Baobab](https://github.com/Gandi/baobab) - previously used at [Gandi](https://gandi.net/), replaced with statuspage.io, Django based
|
|
|
* [Baobab](https://github.com/Gandi/baobab) - previously used at [Gandi](https://gandi.net/), replaced with `statuspage.io`, Django based
|
|
|
|
|
|
### Hack-ish solutions
|
|
|
### Hacks
|
|
|
|
|
|
Those were discarded because they do not provide an "out of the box"
|
|
|
experience:
|
... | ... | @@ -377,12 +377,12 @@ experience: |
|
|
* [GitLab](https://status.gitlab.com) - based on [status.io](https://status.io/)
|
|
|
* [Github](https://status.github.com/) - "Battle station fully operational", auto-refresh,
|
|
|
twitter-connected, simple color coded (see [this blog post for
|
|
|
more details](https://github.com/blog/1240-new-status-site)), not open-source (confirmed in personnal email
|
|
|
between github support and anarcat on 2013-05-02)
|
|
|
more details](https://github.com/blog/1240-new-status-site)), not open-source (confirmed in personal email
|
|
|
between GitHub support and anarcat on 2013-05-02)
|
|
|
* [Potager.org](https://meteo.potager.org/) - ikiwiki based
|
|
|
* [Riseup.net](https://status.riseup.net/) - RSS feeds
|
|
|
* [Signal](https://status.signal.org/) - simple, plain HTML page
|
|
|
* [sr.ht](https://status.sr.ht/) - cstate
|
|
|
* [sr.ht](https://status.sr.ht/) - cState
|
|
|
* [Twilio](https://status.twilio.com/) - email, slack, RSS subscriptions, lots of services
|
|
|
shown
|
|
|
* [Wikimedia](http://status.wikimedia.org/) - based on [proprietary nimsoft software](http://www.nimsoft.com/solutions/nimsoft-cloud-user-experience/key-features/public-status-page.html?m=41159&c=pspfoot),
|
... | ... | |