💡 An open source solution for publishing the status of your services
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 23 commits behind adamcooke:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
app
bin
config
content
db
doc/api
lib
log
public
test
.gitignore
CHANGELOG.md
DOCKER_README.md
Dockerfile
Gemfile
Gemfile.lock
LICENSE
Procfile
Procfile.options
README.md
ROADMAP.md
Rakefile
config.ru
docker-start.sh

README.md

Staytus

Staytus is a complete solution for publishing the latest information about any issues with your web applications, networks or services. Along with absolutely beautiful public & admin interfaces, Staytus is a powerful tool for any organization with customers that rely on them to be online 24/7.

Screenshot

Installation from source

System Requirements

  • Ruby 2.1 or greater
  • RubyGems and Bundler
  • A MySQL database server
  • Bundler (gem install bundler)
  • Procodile (gem install procodile)

Installation Instructions

A comprehensive tutorial about how to install Staytus available here on the aTech Media blog.

Alternativly, these basic instructions will get you up and running:

Before start, you'll need to create a new MySQL database:

mysql$ CREATE DATABASE `staytus` CHARSET utf8 COLLATE utf8_unicode_ci;
mysql$ GRANT ALL ON staytus.* TO `staytus`@`localhost` IDENTIFIED BY "a_secure_password";
$ git clone https://github.com/adamcooke/staytus
$ cd staytus
$ git checkout stable
$ bundle install --deployment --without development:test
$ cp config/database.example.yml config/database.yml
$ nano -w config/database.yml # Add your database configuration
$ bundle exec rake staytus:build staytus:install
$ procodile start --foreground

This will run the application on HTTP port 5000. When you first login, you'll be able to add your own site settings. Browse to http://[IP]:8787 to begin.

You may also want to change the SMTP configuration via environment variables, which are described in config/environment.example.yml.

To run staytus in the background, simply run procodile start without the --foreground option.

Upgrading

Once you've installed Staytus, you can easily upgrade it by following this process.

$ cd path/to/staytus
$ git pull origin stable
$ bundle
$ bundle exec rake staytus:build staytus:upgrade

Once you've done this, you should ensure you restart any Staytus processes which you have running.

E-Mail Notifications

All e-mail notifications are sent through a background worker process. This will be started automatically when you run the application using foreman start. If you don't do this, you can run jobs using bundle exec rake jobs:work.

Administration

To log in for the first time, visit the /admin, and log in with email admin@example.com and password password. You will probably want to go to Settings -> Users and set up your admins.

Themes

All themes are stored in the content/themes directory. You can add your own themes in this directory but we do not recommend making changes to the default theme as these changes may get overridden in an upgrade.

Full details about how to make these will be coming soon.

## Examples in the wild

If you're running Staytus in the wild, let us know so we can add you to the list.

Screenshots

Here's a few extra screenshots from the admin and public interfaces.

Screenshot

Screenshot

Screenshot

Screenshot

Screenshot