README.md 10.4 KB
Newer Older
Mantas's avatar
Mantas committed
1
<p align="center"><img src="https://raw.githubusercontent.com/cstate/cstate/master/images/highlight.svg?sanitize=true" alt="cState example illustration"></p>
Mantas's avatar
v2-dev2    
Mantas committed
2

Casper's avatar
Casper committed
3
<p align="center"><a href="https://github.com/cstate/cstate/releases"><img src="https://img.shields.io/github/release/cstate/cstate/all.svg?style=flat-square" alt="GitHub release" /></a> <a href="https://github.com/cstate/cstate/commits/master"><img src="https://img.shields.io/github/last-commit/cstate/cstate.svg?style=flat-square" alt="GitHub last commit" /></a> <a href="https://github.com/cstate/cstate/tree/master/"><img src="https://img.shields.io/github/repo-size/cstate/cstate.svg?style=flat-square" alt="GitHub repo size in bytes" /></a> <a href="https://discord.gg/zYCjzys"><img src="https://img.shields.io/badge/discord-support-7289DA.svg?logo=discord&style=flat-square" alt="Discord Chat" /></a> <a href="https://twitter.com/cstate"><img src="https://img.shields.io/twitter/follow/mistermantas.svg?style=social&amp;label=Follow" alt="Twitter" /></a> <a href="https://github.com/ivbeg/awesome-status-pages"><img src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg" alt="Awesome status page" /></a></p>
Mantas's avatar
v2-dev2    
Mantas committed
4

5
> Über fast, backwards compatible (IE8+), tiny, and simple status page built with Hugo. Completely _free_ with Netlify, Netlify CMS.
6

7
[**🎯 Want an example? Click here to see a live demo!**](https://cstate-example.netlify.com)
Mantas's avatar
Mantas committed
8

9
[👩‍💻 You can also see what an example cState project’s source code.](https://github.com/cstate/example)
Mantas's avatar
v2-rc1    
Mantas committed
10

Eduardo Messuti's avatar
Eduardo Messuti committed
11
12
13
14
15
## Sponsors 🏅

<a href="//statuspal.io"><img src="images/statuspal-logo-with-text.png" alt="Statuspal" width="200"></a>


Mantas Vilčinskas's avatar
Mantas Vilčinskas committed
16
17
18
19
20
## Who uses cState? 🥳

Some more examples from the internet:

* [Chocolatey](https://status.chocolatey.org/)
Mantas Vilčinskas's avatar
add tmw    
Mantas Vilčinskas committed
21
* [tmw.media](https://status.tmw.media)
Mantas Vilčinskas's avatar
Mantas Vilčinskas committed
22
23
24
* [Proventa](https://status.proventa.io/) (German)
* [sr.ht](https://status.sr.ht/)
* [Content Ignite](https://status.contentignite.com/)
25
* [FSCI](https://status.fsci.in/)
Mantas Vilčinskas's avatar
Mantas Vilčinskas committed
26
27
28

*Want your status page here? [Create a Pull Request](https://github.com/cstate/cstate/edit/dev/README.md)!*

29
## Contents ⁉
30

31
32
+ [Features](#features-)
+ [Getting started](#getting-started-)
Mantas's avatar
Mantas committed
33
34
  + [Production](#production)
  + [Development](#development)
35
36
37
+ [Updating](#updating-)
+ [FAQ](#faq-)
+ [Contribute](#contribute-)
38
* [Support](#support-)
39
+ [License](#license-)
40

Mantas's avatar
Mantas committed
41
42
***

43
44
45
## Features 😎

**Designed with care**
Mantas's avatar
Mantas committed
46

47
* **New in v4**: automatically ships with dark mode
48
+ Comes with a simple, focused, and extremely light design
49
+ Works not just on mobile, but also on the archaic Internet Explorer 8 for some reason
50
51
+ Makes you accountable, showcasing how long it took for an issue to be resolved
+ Great for data manipulation and viewing — has RSS, tag-like system feeds
52
+ Customizable views, colors, HTML, and other elements
53

54
**Fast, reliable, and free (even to host)**
55
56

+ Built with [Hugo](https://gohugo.io), a hyperfast Golang generator
57
+ Secure, ready for HTTPS; see [JAMstack](https://jamstack.org/)
58
59
60
61
+ Easy to edit and deploy on Netlify for _absolutely free_

**Easy to setup, manage, use**

Mantas's avatar
Mantas committed
62
63
+ Edit your status page from a simple config file
+ Comes pre-equipped with Netlify CMS for quick admin updates
Mantas's avatar
v2-rc1    
Mantas committed
64
+ Extensive documentation on the [wiki](https://github.com/cstate/cstate/wiki)
65
66
+ You can not only create issues, but also informational, about pages
+ **New in v4**: [Read-only API available](https://github.com/cstate/cstate/wiki/API)
Mantas's avatar
Mantas committed
67

68
## Getting started 💻
Mantas's avatar
Mantas committed
69
70

For this tutorial, it is assumed that you have Hugo and Git installed (check with `hugo version` & `git --version`).
Mantas's avatar
Mantas committed
71

72
73
> A minimum version of `0.48` is required for Hugo, starting with v3.

Mantas's avatar
Mantas committed
74
#### Production
Mantas's avatar
Mantas committed
75

76
77
78
79
We encourage you to use [Netlify](https://www.netlify.com) for cState. These are the following options you need to change in deploy settings:

+ Build command: **hugo**
+ Publish directory: **public**
Mantas's avatar
Mantas committed
80
+ Add one build environment variable
81
  + Key: **HUGO_VERSION**
82
  + Value: **0.48** (or later)
Mantas's avatar
Mantas committed
83

Mantas's avatar
Mantas committed
84
85
86
87
88
89
90
91
**The easy way**

You can simply click this button to get started:

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/cstate/example)

This sets up cState with its default settings from the cstate/example repo.

Mantas's avatar
Mantas committed
92
***
Mantas's avatar
Mantas committed
93

Mantas's avatar
Mantas committed
94
95
If you want to do this from any branch in this repository, follow the manual instructions:

Mantas's avatar
Mantas committed
96
97
1. Download the contents of the `exampleSite` directory in this repository. This will be your site guts, which will hold the content and configuration for the status page.
2. Create a `themes` folder and navigate to it on the command line.
Mantas's avatar
Mantas committed
98

99
```bash
Mantas's avatar
Mantas committed
100
101
mkdir themes; cd themes;
```
Klaus's avatar
Klaus committed
102
103
104
105
106
2. Start Git on this folder: 

```bash
git init
```
Mantas's avatar
Mantas committed
107

Mantas's avatar
Mantas committed
108
3. Now simply add a Git submodule pointing to this repository, like so:
109

Mantas's avatar
Mantas committed
110
```bash
Mantas's avatar
v2-rc1    
Mantas committed
111
git submodule add https://github.com/cstate/cstate
112
```
113

Mantas's avatar
Mantas committed
114
4. Set up cState for your liking. It is now ready to be used in production.
Mantas's avatar
Mantas committed
115
116

#### Development
117

Mantas's avatar
Mantas committed
118
1. Clone this repository in the command line:
119

Mantas's avatar
Mantas committed
120
```bash
121
git clone --recursive -b master https://github.com/cstate/cstate.git
Mantas's avatar
Mantas committed
122
```
123

Mantas's avatar
Mantas committed
124
2. Navigate to the theme directory:
125
126

```bash
127
cd cstate/exampleSite
Mantas's avatar
Mantas committed
128
```
129

Mantas's avatar
Mantas committed
130
3. Launch the development setup much like this:
131

Mantas's avatar
Mantas committed
132
```bash
133
hugo serve --baseUrl=http://localhost/ --theme=cstate --themesDir=../.. --verbose
134
135
```

Mantas's avatar
Mantas committed
136
137
138
The main directory is the theme itself (the cState guts, basically) and the `exampleSite` folder houses all content. Use this local setup to experiment before deploying to production!

If you would like to commit/make a PR, make sure that `themesDir` is a comment before trying to merge upstream.
139

140
## Updating 🎉
141

142
**If you are updating from one major version to another, like from v3 to v4, then please [read the migration guides](https://github.com/cstate/cstate/wiki/Usage#migration-guides).**
143

144
Assuming the production install instructions were followed, keep cState updated by having an up to date Git submodule in the `themes` folder. containing this repository. Your content will stay separate.
Mantas's avatar
Mantas committed
145

146
Ask yourself these questions:
147

148
149
150
151
152
1. Do I already have the **up to date** Git repository with my status page on my computer?
  * If not, go to your desktop or somewhere else, where you can download your Git repository and run: `git clone --recursive <your repo link goes here> && git submodule foreach git pull origin master`.
  * In the parent directory, type `hugo serve`. Check to see if everything is working.
  * Then do `git add -A; git commit -m "Update cState"; git push origin master; exit`. Your status page is now updated.
2. If you **DO** have the directory, go inside `themes/cstate`. If that is empty, it is easier to delete your local copy and do the steps outlined earlier.
Mantas's avatar
Mantas committed
153

154
There is currently no easier way to do this, unfortunately, you will need the terminal / command line / Git Bash, unless you want to create a new status page from scratch and move your data over manually.
Mantas's avatar
Mantas committed
155

156
More info about submodules: [updating](https://stackoverflow.com/a/5828396) & [cloning](https://stackoverflow.com/questions/3796927/how-to-git-clone-including-submodules).
Mantas's avatar
Mantas committed
157

158
## FAQ 🤔
Mantas's avatar
Mantas committed
159

160
161
162
163
### Are there settings you can change?

Yes, most of the settings are in the `config.yml` file or under _Settings_ in Netlify CMS.

Mantas's avatar
Mantas committed
164
165
166
167
168
169
170
### Where do issues go?

#### Using an admin panel (Netlify CMS)

This takes a little more effort to set up but pays off in the long run — [see the wiki](https://github.com/cstate/cstate/wiki) for up to date information.

#### Doing it from the Git repository
171

172
Create a file in `content/issues`. The name of the file will be the slug (what shows up in the URL bar). For example, this is what `2017-02-30-major-outage-east-us.md` should look like:
173
174
175

```md
---
Mantas's avatar
Mantas committed
176
177
title: Major outage in East US
date: 2017-02-30 14:30:00
SUNNY's avatar
SUNNY committed
178
resolved: true
Mantas's avatar
Mantas committed
179
180
181
resolvedWhen: 2017-02-30 16:00:00
severity: down
affected:
Mantas's avatar
Mantas committed
182
  - API
Mantas's avatar
Mantas committed
183
section: issue
184
185
---

Mantas's avatar
Mantas committed
186
*Monitoring* - After hitting the ole reboot button Example Chat App is now recovering. We’re going to continue to monitor as everyone reconnects. {{< track "2018-04-13 16:50:00" >}}
Mantas's avatar
Mantas committed
187

Mantas's avatar
Mantas committed
188
*Investigating* - We’re aware of users experiencing unavailable guilds and issues when attempting to connect. We're currently investigating. {{< track "2018-04-13 15:54:00" >}}
189
190
```

191
192
Time to break that down.

Mantas's avatar
Mantas committed
193
194
195
196
197
198
199
`title`: This is the one of the most important parts of an incident. *(required)*  
`date`: An ISO-8601 formatted date. Does not include time zone. This is when you first discovered the issue. *(required)*  
`resolved`: Whether issue should affect overall status. Either `true` or `false`. *(boolean, required)*  
`resolvedWhen`: An ISO-8601 formatted date. Does not include time zone. This is when downtime stopped. You may set the time that downtime ended without completely resolving the issue (thus leaving time for monitoring).  
`severity`: If an issue is not resolved, it will have an applied severity. There are 3 levels of severity: `notice`, `disrupted`, and `down`. If there are multiple issues, the status page will take the appearance of the more drastic issue (such as `disrupted` instead of `notice`). *(required)*  
`affected`. Add the items that were present in the config file which should alter the status of each individual system (component). *(array, required)*  
`section`. This must be `issue`, so that Hugo treats it as one. *(required)*  
200

Mantas's avatar
v2-rc1    
Mantas committed
201
202
203
204
### I have more questions!

Check out [the wiki](https://github.com/cstate/cstate/wiki).

205
206
207
208
209
210
211
## Support ❤️

cState is only a hobby project of @mistermantas, but it has turned into something a little bit bigger.

Please **star, share, and use the software**. Thank you, if you do.

If you wish to support the project financially:
Mantas's avatar
Mantas committed
212

213
[Sponsor the author @mistermantas on GitHub](https://github.com/sponsors/mistermantas)
Mantas's avatar
Mantas committed
214

215
[Support the author on PayPal](https://www.paypal.me/mistermantas)
Mantas's avatar
Mantas committed
216
217


218
## Contribute 💥
219

220
> Want to become a maintainer? Hit me up [on Twitter @mistermantas](https://twitter.com/mistermantas)
Mantas's avatar
Mantas committed
221

222
+ Glance over the [Code of Conduct](/CODE_OF_CONDUCT.md).
Mantas's avatar
v2-rc1    
Mantas committed
223
+ Before submitting a pull request, create an issue to [discuss the implications of your proposal](https://github.com/cstate/cstate/issues).
224
+ Or if you are a translator — [see this](https://github.com/cstate/cstate/wiki/Translations#add-your-translations).
225
226
+ Write consistent, simple, readable code, and precise documentation.
+ Version numbers should be added in the JS partial, the meta[generator] tag, and API index!
227
228

## License ✍
229

230
[MIT](https://github.com/cstate/cstate/blob/master/LICENSE.md) © [Mantas Vilčinskas](https://github.com/mistermantas)
231

232
Thanks to all the [contributors](https://github.com/cstate/cstate/graphs/contributors)!