0.0
No commit activity in last 3 years
No release in over 3 years
Web application for Usbunfreeze kit
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 10

Runtime

~> 4.0
~> 3.4
~> 1.4
~> 1.6
~> 2.0
 Project Readme

UsbunfreezeWeb

Gem Version Dependency Status

Web application for Usbunfreeze kit.

Installation

UsbunfreezeWeb is a Sinatra/Rack application and can be used as a gem or as a server in local directory.

As a gem (recommended)

  1. Install a gem

     gem install usbunfreeze_web
    
  2. Point an env variable USBUNFREEZE_WEB_SETTINGS to location of a settings file /path/to/settings.yaml (see Configurarion).

  3. Start an app as a Thin server

     USBUNFREEZE_WEB_SETTINGS=/path/to/settings.yaml usbunfreeze_web
    

Of course, you can provide any additional Thin options at command line or even a config with -C /path/to/thin.yaml.

As a rack app

UsbunfreezeWeb can be started using config.ru with you favourite Rack server.

  1. Clone a git repo

  2. Install dependencies

     bundle install
    
  3. Point an env variable USBUNFREEZE_WEB_SETTINGS to location of a settings file /path/to/settings.yaml (see Configurarion).

  4. Start Rack app

     rackup
    

Configuration

Settings file template can be found at config/settings.yaml.example.

Configure Amazon AWS SQS queue and place access, secret key and queue name to the config.

NOTE: server does not work properly with sinatra-assetpack asset packaging in production mode. Use development instead.

Usage

Web application is configured to serve at /usbunfreeze for a web page and at /usbunfreeze-assets for assets. Configure your HTTP server for secure proxying requests to the web application.

Use URL http://localhost:9292/usbunfreeze to send a signal message to the SQS which will be fetched by the companion application usbunfreeze_daemon.

License information

Please consult with the LICENSE.txt for license information. It is MIT by the way.