Curtains

Please note, this is still in development.

Curtains is a Elixir package that "takes over" your Elixir website by returning content of a specified file (if it exists). This makes it perfect for "Under construction" and "Maintenance" pages. At it's heart, it's just a Plug.

Installation

The package can be installed as:

Add curtains to your list of dependencies in mix.exs:
def deps do
```
 [{:curtains, "~> 0.0.1"}]
```
end
Ensure curtains is started before your application:
def application do
```
 [applications: [:curtains]]
```
end
Run mix deps.get

Usage

Add Curtains to your desired pipeline in the router. For example:

defmodule MyApp.Router do
  use MyApp.Web, :router

  pipeline :browser do
    plug :accepts, ["html"]
    plug :fetch_session
    plug :fetch_flash
    plug :protect_from_forgery
    plug :put_secure_browser_headers
    plug Curtains
  end

  ...
end

With this config, Curtains will take over any browser requests coming to the application and will display the default Curtains page:

Curtains

Changing the default curtain

In your config.exs or <env>.exs file, add:

config :curtains, curtain_file: "/path/to/any/file.html"

Make sure you restart your application after changing the config.

Using static assets in the curtain page

Make sure that the host application is serving the static assets you want to use on the curtain HTML page.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

License

This work is free. You can redistribute it and/or modify it under the terms of the MIT License. See the LICENSE file for more details.