kotovalexarian-likes-github/puma--puma
1
0
Fork 0
mirror of https://github.com/puma/puma.git synced 2022-11-09 13:48:40 -05:00
Code Releases Activity

Add inital docs about plugins

Browse source
This commit is contained in:
Evan Phoenix 2016-02-25 14:42:36 -08:00
parent f0762d1216
commit ac7e47373d
1 changed files with 31 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -1,6 +1,6 @@
# Puma: A Ruby Web Server Built For Concurrency
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/puma/puma?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/puma/puma?utm\_source=badge&utm\_medium=badge&utm\_campaign=pr-badge)
[![Build Status](https://secure.travis-ci.org/puma/puma.svg)](http://travis-ci.org/puma/puma)
[![Dependency Status](https://gemnasium.com/puma/puma.svg)](https://gemnasium.com/puma/puma)
[![Code Climate](https://codeclimate.com/github/puma/puma.svg)](https://codeclimate.com/github/puma/puma)
@ -29,6 +29,36 @@ Now you should have the `puma` command available in your PATH, so just do the fo
$ puma app.ru
## Plugins
Puma 3.0 added support for plugins that can augment configuration and service operations.
2 canonical plugins to look to aid in development of further plugins:
* [tmp\_restart](https://github.com/puma/puma/blob/master/lib/puma/plugin/tmp_restart.rb): Restarts the server if the file `tmp/restart.txt` is touched
* [heroku](https://github.com/puma/puma-heroku/blob/master/lib/puma/plugin/heroku.rb): Packages up the default configuration used by puma on Heroku
Plugins are activated in a puma configuration file (such as `config/puma.rb'`) by adding `plugin "name"`, such as `plugin "heroku"`.
Plugins are activated based simply on path requirements so, activating the `heroku` plugin will simply be doing `require "puma/plugin/heroku"`. This allows gems to provide multiple plugins (as well as unrelated gems to provide puma plugins).
The `tmp_restart` plugin is bundled with puma, so it can always be used.
To use the `heroku` plugin, add `puma-heroku` to your Gemfile or install it.
### API
At present, there are 2 hooks that plugins can use: `start` and `config`.
`start` runs when the server has started and allows the plugin to start other functionality to augment puma.
`config` runs when the server is being configured and is passed a `Puma::DSL` object that can be used to add additional configuration.
Any public methods in `Puma::Plugin` are the public API that any plugin may use.
In the future, more hooks and APIs will be added.
## Advanced Setup
### Sinatra