Skip to content

haytona/towncrier

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

towncrier

A simple status dashboard.

features

  • Standalone - just Perl and some modules, no web server or database required
  • REST API - including a public read-only one
  • RSS feeds

setup

docker

Docker is the easiest way to get things running:

$ docker run --name=towncrier -d -p 8080:8080 robn/towncrier

Existing Perl with Carton

If you have a system with a fairly recent Perl already, then Carton is your next best choice:

$ git clone https://github.com/robn/towncrier.git
$ cd towncrier
$ curl -L https://cpanmin.us | perl - Carton
$ carton install --deployment
$ carton exec plackup bin/app.pl

For production you'll need to know a little more about Perl webapp deployment. Go and read the docs for Carton and Dancer::Deployment.

anything else

Get Perl, get all the dependencies, run the program. This is the developer option, and you're expected to know what you're doing :)

first run

You need to install the initial statuses and services. Look at bin/fixtures.sh to get started.

There's some knobs you can twiddle in config.yml.

demo

FastMail are using this. See https://www.fastmailstatus.com/

credits and license

Copyright (c) 2014 Robert Norris. MIT license. See LICENSE.

towncrier started as a clone of Stashboard. The templates, stylesheets and general layout are lifted from it. So Copyright (c) 2010 Twilio Inc.

Uses Font Awesome by Dave Gandy. https://fontawesome.io

Uses Pure CSS by Yahoo!. https://purecss.io

Bell icon by icons8.com

I think that's everyone.

contributing

Please hack on this and send pull requests :)

About

A status dashboard

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Perl 61.9%
  • Other 19.6%
  • CSS 15.6%
  • Shell 2.9%