README.md in capistrano-nginx-unit-0.5.0 vs README.md in capistrano-nginx-unit-0.6.0
- old
+ new
@@ -1,10 +1,11 @@
# capistrano-nginx-unit
## Installation
```rb
+# Gemfile
gem "capistrano-nginx-unit"
```
## Usage
@@ -28,10 +29,11 @@
cap nginx_unit:stop # Stop NGINX Unit process
```
`nginx_unit:attach` is main task.
The task [sends HTTP request to configure NGINX Unit](http://unit.nginx.org/configuration/) on server.
+When NGINX Unit process received the request, launches rack application process.
If you want to apply new code when deployed, please invoke `nginx_unit:attach` task after `deploy:published`.
```rb
# deploy.rb
after "deploy:published", "nginx_unit:attach"
@@ -39,13 +41,11 @@
## Options
```rb
set :nginx_unit_roles, -> { :app }
-set :nginx_unit_pid, -> { "/var/run/unit.pid" }
set :nginx_unit_control_sock, -> { "/var/run/control.unit.sock" }
-set :nginx_unit_options, -> { "" }
set :nginx_unit_listen, -> { "*:3000" }
set :nginx_unit_app_name, -> { fetch(:application) }
set :nginx_unit_processes, -> { nil }
set :nginx_unit_user, -> { nil }
set :nginx_unit_group, -> { nil }
@@ -55,20 +55,12 @@
- `:nginx_unit_roles`
Roles to run tasks for NGINX Unit. Default: `:app`
- - `:nginx_unit_pid`
-
- Path to NGINX Unit's pid file. Default: `"/var/run/unit.pid"`
-
- `:nginx_unit_control_sock`
Path to NGINX Unit's unix domain socket path. Default: `"/var/run/control.unit.sock"`
-
- - `:nginx_unit_options`
-
- Additional options that is used when launch NGINX Unit by `nginx_unit:start`
- `:nginx_unit_listen`
IP Address and port where rack application listens on. Default: `"*:3000"`
See [Listeners configuration](https://unit.nginx.org/configuration/#listeners)
\ No newline at end of file