💡 An open source solution for publishing the status of your services. https://status.lrk.sh

Lukas Fülling db1d022c40 add service group to more places 7 months ago
api 6ade150dab upgrade to rails 5.1 (plus a number of gem upgrades) 3 years ago
app db1d022c40 add service group to more places 7 months ago
bin 6ade150dab upgrade to rails 5.1 (plus a number of gem upgrades) 3 years ago
config d987466be4 fix locale path 7 months ago
content b0c783a938 add service group to service lists 7 months ago
db de8e115986 update web link 7 months ago
doc c589a36dbe add API access to issues 5 years ago
lib 2d268fedba version bump, remove google fonts 7 months ago
log 4a86b8a37a Initial commit 6 years ago
public b9715d9438 robots.txt 6 years ago
.gitignore 2d268fedba version bump, remove google fonts 7 months ago
CHANGELOG.md 6ade150dab upgrade to rails 5.1 (plus a number of gem upgrades) 3 years ago
DOCKER_README.md 838ad055ef update readmes 4 years ago
Dockerfile 4246e87dd1 Working docker config, persisting only DB + DB config (not themes) 5 years ago
Gemfile 54b9edd847 add autoprefixer 7 months ago
Gemfile.lock 54b9edd847 add autoprefixer 7 months ago
LICENSE 8fb4c7b942 add MIT license 6 years ago
Procfile acb1965781 upgrade docs for procodile 4 years ago
Procfile.options acb1965781 upgrade docs for procodile 4 years ago
README.md 4c20da1119 update readme 7 months ago
ROADMAP.md 014d6a2951 update source link 7 months ago
Rakefile 4a86b8a37a Initial commit 6 years ago
config.ru 4a86b8a37a Initial commit 6 years ago
docker-start.sh 4246e87dd1 Working docker config, persisting only DB + DB config (not themes) 5 years ago

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.

Installation from source

System Requirements

  • Ruby 2.3 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://git.lrk.sh/lerk/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
$ cp config/environment.example.yml config/environment.yml
$ nano -w config/environment.yml # Add your environment 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