cachethq/cachet

🚦 The open-source status page system.

Cachet, the open-source status page system.

Cachet 3.x Announcement

We are shifting our attention and resources to Cachet 3.x and will no longer be supporting the 2.x version.

For more information on the Cachet rebuild and our plans for 3.x, you can read the announcement here.

Features

• List your service components
• Report incidents
• Customise the look of your status page
• Markdown support for incident messages
• A powerful JSON API
• Metrics
• Multi-lingual
• Subscriber notifications via email
• Two factor authentication

Requirements

• PHP 7.1.3 – 7.3
• HTTP server with PHP support (e.g.: Apache, Nginx, Caddy)
• Composer
• A supported database: MySQL, PostgreSQL or SQLite

Installation, Upgrades and Documentation

You can find documentation at https://docs.cachethq.io.

Here are some useful quick links:

• Installing Cachet
• Getting started with Docker

Demo

To test out the demo, you can log in to the Cachet dashboard with the following credentials:

• Username: test or [email protected]
• Password: test123

Note The demo will automatically reset every 30 minutes.

Security Vulnerabilities

If you discover a security vulnerability within Cachet, please send an e-mail to [email protected]. All security vulnerabilities are reviewed on a case-by-case basis.

cachet's Issues

Tests

Since Cachet is being developed to be deployed live (straight from master) it should at least go through some tests.

• Create test suite
• Link Travis CI

I'm not too worried about 100% coverage straightaway. We can spend time writing tests later on.

Email templates

We'll need an email template setting up for notifications and team member invitations later on. Any template we use should:

• Be able to pick up on theme overrides.
• Work across all major email clients.
• Responsive so that it's easily readable on phones, tablets etc.
• Not be restrictive on layout, for instance a notification will look different to a team member invitation etc.

Guzzle 5 Support

WIll we be upgrading to guzzle 5 any time soon? The upgrade should be quite easy.

[Proposal] New Cachet Logo

Hi ! I've made a proposal of the logo. Let me know what you think!

Cheers :)

Scheduled maintenance

What do we think about adding a separate status level for "scheduled". I'm not 100% sure on this since we could also add a date box on the incident page which can be set in the future. The status page will then detect future dates and list them appropriately as scheduled.

Intro to Git & GitHub Resources

What are some of the best resources out there for introducing someone to a version control workflow and getting setup with GitHub?

I will be compiling resources together for the contribution doc to make getting started with the project much simpler for those looking to help out on their first OSS project.

Steps to launch

Once Cachet is setup, I think that we could display "steps to launch" in the dashboard index, it'll basically walk them through the things they've left to do:

1. Setup Cachet (ticked obviously)
2. Login to dashboard (ticked, because they should be auto logged in).
3. Add components (ticked once there are > 0 components in the DB).
4. Add first incident (ticked once there are > 0 incidents in the DB).
5. Customize Cachet with theme settings.

Then a button to hide the steps.

By adding this kind of feature we're showing the user how to use Cachet in a non-invasive way.

I'm thinking of something like this:

Update system

We need some way of updating Cachet from an existing installation. This will keep Heroku users up to date and make it easier for manual installations to stay up to date too.

• Option to turn off update checking.
• Only check for updates whilst we've not got an active version to update too already.
• Visual notification that an update is available.
• Use GitHubs releases API to find the latest version.
• Download the update to ./app/storage/updates
• Copy over the new files, which have changed.
• Run composer update
• Option to allow dev-master style updates that will use the master branch, with a big warning.

Interface for integration with others services

Would be nice if we can receive a status from HipChat or w/e.

• Hipchat
• SMS (Twilio)
• WhatsApp
• Slack
• Email (subscribers).

PDOException: Integrity constraint violation 19 NOT NULL constraint failed

jamesbrooks@jbrooksuk Cachet (master) $ php artisan tinker
$[1] > $incident = new Incident;
// object(Incident)(
//   'incrementing' => true,
//   'timestamps' => true,
//   'exists' => false
// )
[2] > $incident->name = "Test";
// 'Test'
[3] > $incident->message = "This is a test incident. Something went wrong.";
// 'This is a test incident. Something went wrong.'
[4] > $incident->save();
PHP Fatal error:  Uncaught exception 'PDOException' with message 'SQLSTATE[23000]: Integrity constraint violation: 19 NOT NULL constraint failed: incidents.status' in /Users/jamesbrooks/Sites/Cachet/vendor/laravel/framework/src/Illuminate/Database/Connection.php:369
Stack trace:
#0 /Users/jamesbrooks/Sites/Cachet/vendor/laravel/framework/src/Illuminate/Database/Connection.php(369): PDOStatement->execute(Array)
#1 /Users/jamesbrooks/Sites/Cachet/vendor/laravel/framework/src/Illuminate/Database/Connection.php(617): Illuminate\Database\Connection->Illuminate\Database\{closure}(Object(Illuminate\Database\SQLiteConnection), 'insert into "in...', Array)
#2 /Users/jamesbrooks/Sites/Cachet/vendor/laravel/framework/src/Illuminate/Database/Connection.php(581): Illuminate\Database\Connection->runQueryCallback('insert into "in...', Array, Object(Closure))
#3 /Users/jamesbrooks/Sites/Cachet/vendor/laravel/framework/src/Illuminate/Database/Connection.php(370): Illuminate\Database\Connection->run('insert into "in...', Array, Object(Closure)) in /Users/jamesbrooks/Sites/Cachet/vendor/laravel/framework/src/Illuminate/Database/Connection.php on line 625
[5] > exit;

I rarely use SQLite, so it's probably an obvious error.

Tracking

I'm wondering whether it'd be worth adding some kind of internal tracking that gets sent to directly back to us, to see how often something happens.

We'd only need to track:

• Installs
• Components; added, edited, deleted
• Incidents; added, edited, deleted
• Notifications

Then we'd have enough data to use as "we've had x installs" etc.

Of course, there are things like:

• Security
• Privacy

That we'd need to take care of.

Subscribe Option

Being able to subscribe to the status page would be a neat feature. Every time a component/incident is added the subscribers would get an email.

Implement jquery.minicolors.js

Implement jquery-minicolors into the theme settings will make it easier for the user to customise the theme with no hex colour experience.

Class 'BadConfigKeyException' not found

After installing Cachet, I'm getting the following error:

Class 'BadConfigKeyException' not found 

Screenshot:

Roadmap v1.0.0

The First Release milestone is coming up (due 22nd December). If you're new to Cachet or unsure of what work needs to be done towards getting this first release out, here is a rundown of what needs to be done.

• Design (#2) - @Ehesp has mocked up the dashboard within the ui repository. This needs converting into HTML and CSS as a reusable set of components as the design will be used for the dashboard, setup and login screens.
• API (#3, #25) - The API is almost finished however we need to add authorization for use within the Cachet app itself. This could be achieved with the app token.
• Setup page (#12)
• Once the design is complete we'll need to be able to create components, incidents, metrics and users from the dashboard.

Essentially this is all that is needed for a first release. We'll be able to refine and add more features later on.

Fix Heroku deployment when both composer.json and package.json exist

Heroku deployment will break when there is a composer.json and package.json as the buildstep favours Node.js deployment over PHP.

I know that there are ways to change the buildpack when creating an app, but we need to investigate whether this is possible from within app.json.

We'll probably want to get in touch with @heroku themselves on this.

Setup page

When installing from Heroku, it'd be good to have some kind of setup page which:

• Setup required app_name, app_url, show_support settings.
• Creates an admin account.

Request: Use Heroku's own PostgreSQL instead of an addon MySQL

Hey,

I would've liked this app to use PostgreSQL instead of MySQL as then I don't need to give my payment information to Heroku in order to deploy this. Heroku seem to want payment info if you use an addon.

Is it possible to change the deployment to using Heroku's PostgreSQL so that it can be deployed without the need for payment information?

Heroku Button Support

It would be awesome to have the one click deploy to Heroku button added to the project!

https://blog.heroku.com/archives/2014/8/7/heroku-button

It looks pretty simple to implement and would surely increase the number of users that give it a shot! Heroku provides a free tier so it lowers the barrier to entry to almost nil...

Gulp/Elixir fonts issue

Currently the CSS are being loaded from public/build/css, so the fonts for Bootstrap and FontAwesome need to be within public/build/fonts.

Currently I'm using the copy command:

.copy('app/assets/bower_components/bootstrap/dist/fonts/', 'public/build/fonts')
.copy('app/assets/bower_components/fontawesome/fonts/', 'public/build/fonts');

This works, however it throws an error if it is run when the fonts are already there, and seems to remove them... which sucks.

There is a publish command, however that doesn't work with gulp watch. Really not sure what to do.

Currently while watching, I don't see the icons, but before pushing I have to run gulp, to copy them in.

EDIT:

Error: ENOENT, open '/Users/elliothesp/Documents/Code/Cachet/application/public/build/fonts/glyphicons-halflings-regular.eot'

This error occurs when running gulp, and the fonts are already there.

Setup wizard

Rather than the current setup page, we may be better off with a "wizard" style setup. Again using the same inspiration, this is what I have in mind:

Pros to a wizard:

• We can add more setup stages, team member lists etc.
• It's cleaner since each stage is under a new section.
• Visible progress.

Cons:

• May look like there is more to do, will users always finish installation?
• JavaScript is required to deal with the transition of stages.

Settings aren't saving

When changing the background colour, it's no longer being saved.

API: Allowed domains

For security we could allow the API to only be accessed from certain domains. This could simply be a textarea which you write domains on a new line and restricts requests based on the Origin and Referer headers.

Leaving it empty would open the API to anyone (with authentication).

Split into a Github organisation

Creating an organisation on Github (cachet) and having repositories would make things easier to manage and contribute.

Examples:

• cachet/website
  -- Laravel 4 web project
• cachet/ui
  -- Bower based project, allowing other repositories to pull in this bower project and use. This keeps design pull requests/commits away from the actual application.

You get the idea... I know @jbrooksuk it'd pull the project away from being 'yours' but in hind site this would turn out to be a huge project and having one repository would be messy.

Moodboards

Design inspiration for reference while creating elements and layouts for Cachet.

i.e. Astral, nice color scheme and layout

Error on setup

Illuminate \ Database \ Eloquent \ MassAssignmentException 
username

I think that username needs to be added to $fillable.

application.css Not Found

http://status.[mydomain].com/css/application.css Failed to load resource: the server responded with a status of 404 (Not Found)

There's no application.css in any folder. I followed the installation instructions on a VPS. The dashboard styling seems to work just fine, but the main page is completely unstyled.

Use environment files

To keep sensitive data out of the application/repository, use .env files where possible.

• Database Config
• Application key

Metrics

A way of adding/sending and displaying metrics would be cool. For example, you could send a metric to Cachet showing how many requests are being made each second, or latency etc. This relies on #4.

Design

Cachet needs a design which:

• Allows for overrides on elements, logo, colours etc.
• Supports multiple templates (maybe 2-3 of them).
• Support for custom CSS to completely override a template.
• Is easy to read and supports everything that is needed.

I'd be forever grateful if somebody wanted to give this a go? I'm not much of a designer myself.

For those who are interested in creating a design, I love how Astral looks and feels. That kind of layout and feel would suit Cachet IMHO.

Living Styleguide Solutions

I would like to set up the design contribution workflow with a living styleguide, i.e. Pattern Lab, with easily reusable components for use and reference in the project. I have seen several workflows that use grunt, gulp, or some other front-end build tool to dynamically build the guide. I would like to make it as simple as possible to setup, run, and contribute changes. If you have seen any good solutions, please comment below.

This guide could live in a Design branch to separate contribution concerns, thoughts on this are also welcome.

Caching

Something that I've not really considered yet is caching of results. Every page refresh hits the database, so we should cache results, if only for a minute.

• Enable apcu for Heroku
• Configure cache settings per-environment

Documentation

We need some documentation being written:

• Introduction to Cachet
• Setup
• Dashboard
• API

Environment detection

You should implement a environment detection or doc it if already exist.

Metrics

Displaying graphs of incidents per day could be useful for the more visually-inclined. Chart.js is super easy to use and produces sweet charts.

Customizable Component and Incident statuses

At the moment the human statuses are hard set, but it may be better if they were customizable. The reason for this is that the Status Page may want to be setup to be more friendlier for internal use perhaps, so things like "Partial Outage" don't make sense.

This would need some thought because obviously the UI would be built around the options, we'd run out of icons and colors too.

If we decide not to do this, then the statuses would need setting up as a language file.

Split sidebar into separate pages

For the sake of getting V1 out and not having to write much JavaScript I want to separate what would be the "tabs" in each section into sub-pages.

This means that where we currently have:

• Dashboard
• Components
• Incidents
• ...

We'd now have:

• Dashboard
• Components
  • Add
  • Edit
  • Delete
• Incidents
  • Add
  • Edit
  • Delete
• ...

Or whatever.

The problem I encountered with tabs (without AJAX) is that the page redirects to the wrong tab. There are hacks for this, sure, but it's not very nice.

Database migration fails

Changed the database.php file to have the following entry:

    'default' => 'sqlite',

    'connections' => [
        'sqlite' => [
            'driver'   => 'sqlite',
            'database' => '/var/hosting/-redacted-/sfdstatus.db',
            'prefix'   => '',
        ],
    ],

Create a new sqlite3 database (sqlite3 /var/hosting/-redacted-/sfdstatus.db "") and then ran:

# php composer.phar install
Loading composer repositories with package information
Installing dependencies (including require-dev) from lock file
Nothing to install or update
Generating autoload files
Generating optimized class loader
Migration table created successfully.



  [Illuminate\Database\QueryException]                                                                                                                              
  SQLSTATE[HY000]: General error: 1 near "CHANGE": syntax error (SQL: ALTER TABLE `incidents` CHANGE `component` `component_id` TINYINT(4)  NOT NULL  DEFAULT '1')  






  [PDOException]                                                 
  SQLSTATE[HY000]: General error: 1 near "CHANGE": syntax error  



migrate [--bench[="..."]] [--database[="..."]] [--force] [--path[="..."]] [--package[="..."]] [--pretend] [--seed]


Script php artisan migrate handling the post-install-cmd event returned with an error



  [RuntimeException]                                                                                                                                                    
  Error Output:                                                                                                                                                         

    [Illuminate\Database\QueryException]                                                                                                                                
    SQLSTATE[HY000]: General error: 1 near "CHANGE": syntax error (SQL: ALTER TABLE `incidents` CHANGE `component` `component_id` TINYINT(4)  NOT NULL  DEFAULT '1')    


    [PDOException]                                                                                                                                                      
    SQLSTATE[HY000]: General error: 1 near "CHANGE": syntax error                                                                                                       

  migrate [--bench[="..."]] [--database[="..."]] [--force] [--path[="..."]] [--package[="..."]] [--pretend] [--seed]                                                    



install [--prefer-source] [--prefer-dist] [--dry-run] [--dev] [--no-dev] [--no-plugins] [--no-custom-installers] [--no-scripts] [--no-progress] [-v|vv|vvv|--verbose] [-o|--optimize-autoloader] [--ignore-platform-reqs] [packages1] ... [packagesN]

#

Language files for content

The setup page contains static text for:

• Service Details
• Status Page Setup
• Show support for Cachet?
• etc...

All of these need moving into the app/lang/en/cachet.php language file.

Display a banner

StatusPage.io allows you to upload a banner that can be displayed on the status page itself. Cachet could also offer this feature, however one problem is in my mind.

How do we upload files on to Heroku which is temporary storage until the next push?

Split DashboardController

DashboardController is doing a lot of work and has several methods to it, for the different dashboard pages.

Let's make use of Route::controller and get ready made controller code made for us, for each page. We'd end up with a lot of controllers:

• DashIncidentsController
• DashComponentsController
• DashMetricsController
• DashNotificationsController
• DashSettingsController

Thoughts?

include a document on how to use it

So far it looks like an interesting project. I would like to implement it into my app but I haven't find a way on how to use this. Since I have no background in laravel, I can't operate this app. Any further documentation? Thanks (:

Dashboard

There needs to be a way to add components and incidents to the database, as manually entering them does not provide an easy integration. A decent management panel for Cachet should include:

• Modifying the administrator account. This account will be the one setup during install.
• Adding/modifying team users. These may have been setup during install.
• Changing system settings. Timezone, Site URL, Site Name etc.
• Adding/modifying components.
• Reporting incidents.
• Add/modify metrics.

Idea for new status page design

I've had an idea for a new kind of status page layout. What if we used a timeline design? We could still list each day, but under it would be a timeline view, with each icon being the status:

@HipsterBrown what do you think?

If needed

If needed i could help design the HTML/CSS markup. Not much of a dev but i can design. Astral isn't responsive, would you want it to be? Because there are more possibilities in designing PC only (with mobile support).

Heroku deployment is no longer working

The redirection to setup results with:

Whoops, looks like something went wrong.

Not particularly useful.

Interestingly setup works locally, so it must be something specific to the Heroku environment.

The setup page can still be accessed after setup

Once Cachet has been setup, the route should no longer be accessible.

Heroku deploy button failed

Hi,
when I try the deploy to heroku button, it detects an nodejs env and not a php env. So the build failed

-----> Node.js app detected
-----> Resetting git environment
/app/tmp/buildpacks/nodejs/bin/compile: line 35: [: ==: unary operator expected
-----> Defaulting to latest stable node: 0.10.33
-----> Downloading and installing node
-----> Exporting config vars to environment
-----> Installing dependencies
       npm ERR! install Couldn't read dependencies
       npm ERR! Failed to parse json
       npm ERR! Unexpected end of input
       npm ERR! File: /tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/package.json
       npm ERR! Failed to parse package.json data.
       npm ERR! package.json must be actual JSON, not just JavaScript.
       npm ERR! 
       npm ERR! This is not a bug in npm.
       npm ERR! Tell the package author to fix their package.json file. JSON.parse

       npm ERR! System Linux 3.8.11-ec2
       npm ERR! command "/tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/vendor/node/bin/node" "/tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/vendor/node/bin/npm" "install" "--userconfig" "/tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/.npmrc" "--production"
       npm ERR! cwd /tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4
       npm ERR! node -v v0.10.33
       npm ERR! npm -v 1.4.28
       npm ERR! file /tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/package.json
       npm ERR! code EJSONPARSE
       npm ERR! 
       npm ERR! Additional logging details can be found in:
       npm ERR!     /tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/npm-debug.log
       npm ERR! not ok code 0
0 info it worked if it ends with ok
1 verbose cli [ '/tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/vendor/node/bin/node',
1 verbose cli   '/tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/vendor/node/bin/npm',
1 verbose cli   'install',
1 verbose cli   '--userconfig',
1 verbose cli   '/tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/.npmrc',
1 verbose cli   '--production' ]
2 info using [email protected]
3 info using [email protected]
4 verbose config Skipping project config: /tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/.npmrc. (matches userconfig)
5 error install Couldn't read dependencies
6 error Failed to parse json
6 error Unexpected end of input
7 error File: /tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/package.json
8 error Failed to parse package.json data.
8 error package.json must be actual JSON, not just JavaScript.
8 error
8 error This is not a bug in npm.
8 error Tell the package author to fix their package.json file. JSON.parse
9 error System Linux 3.8.11-ec2
10 error command "/tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/vendor/node/bin/node" "/tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/vendor/node/bin/npm" "install" "--userconfig" "/tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/.npmrc" "--production"
11 error cwd /tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4
12 error node -v v0.10.33
13 error npm -v 1.4.28
14 error file /tmp/build_c2546f7b9a12ec1693fab778226c6033/cachethq-Cachet-1144df4/package.json
15 error code EJSONPARSE
16 verbose exit [ 1, true ]

 !     Push rejected, failed to compile Node.js app

Add an RSS feed.

Is useful get the events with RSS. I'm on my last week on college, soon I'll reach you with pull requests :)

API

An API should be able to:

• Create, modify and update components.
• Create, modify and update incidents (also linking to components).
• Support third-party applications which can update statuses and messages.
• Return components & incidents.
• Save who created/last modified components or incidents.
• Metrics API (#25)