Contents

# Lockup

“Can I come into your fort?”

“…what's the codeword?”

## Installation

1. Add this line to your application's Gemfile:

        gem 'lockup'
        
2. Define a codeword (see Usage below).

3. That's it!**

  **If you're passing parameters right at your root (i.e. somedomain.com/:parameter), you'll want to place this mount statement in your routes.rb file, _before_ your other route statements:

        mount Lockup::Engine, at: '/lockup'

## Usage

To set a codeword, define LOCKUP_CODEWORD in your environments/your_environment.rb file like so:

    ENV["LOCKUP_CODEWORD"] = 'secret'

If you're using [Figaro](https://github.com/laserlemon/figaro), set your lockup codeword in your application.yml file:

    LOCKUP_CODEWORD: "love"
    
**Codewords are not case-sensitive, by design. Keep it simple.**

### Link it with no typing:

    http://somedomain.com/or_path/?lockup_codeword=love
    
The visitor is redirected and the cookie is set without them ever seeing the Lockup splash page.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
lockup-0.0.4	README.md