Skip to content

Commit 791d76a

Browse files
author
Andre Ponert
committed
Added provided flow commands fixes #5
1 parent 37d7acc commit 791d76a

1 file changed

Lines changed: 19 additions & 12 deletions

File tree

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ Netlogix.Supervisor
33

44
This package creates supervisor configuration files via flow CLI.
55

6-
Configuration files are named "group-something.conf" when they contain a
7-
supervisor group configuration or "program-something.conf" when they contain
8-
a supervisor program configuration. Both are created at
6+
Configuration files are named "group-something.conf" when they contain a
7+
supervisor group configuration or "program-something.conf" when they contain
8+
a supervisor program configuration. Both are created at
99
Configuration/Supervisor within your application.
1010

1111

@@ -20,19 +20,26 @@ Supervisor allows to "include" other files and even allows for globbing.
2020
files=/etc/supervisor/conf.d/*.conf /var/www/*/Configuration/Supervisor/group.conf /var/www/*/Configuration/Supervisor/program*.conf
2121
```
2222

23-
Creating supervisor files dynamically is intended to be a compile time step,
23+
Creating supervisor files dynamically is intended to be a compile time step,
2424
preferably on deployment.
2525

2626

2727
Available configuration options:
2828
--------------------------------
2929

30-
Program settings get passed to the supervisor configuration file without
30+
Program settings get passed to the supervisor configuration file without
3131
validation, so every current and future configuration option is available.
3232

3333
See: http://supervisord.org/configuration.html#program-x-section-settings
3434

35-
35+
Available flow commands:
36+
-----------------------
37+
```
38+
./flow supervisor:create Creates supervisor configuration
39+
./flow supervisor:startgroups Starts all programs of configured groups
40+
./flow supervisor:stopgroups Stops all programs of configured groups
41+
./flow supervisor:updategroups Reloads config and starts/stops programs accordingly
42+
```
3643
Create supervisor settings via YAML:
3744
------------------------------------
3845

@@ -97,14 +104,14 @@ class Provider implements \Netlogix\Supervisor\Provider
97104
Configure group settings:
98105
-------------------------
99106

100-
Groups are created on demand as soon as a program assigns itself to the
107+
Groups are created on demand as soon as a program assigns itself to the
101108
group. This means groups don't need to be configured beforehand or even at all.
102109

103-
If no further configuration is presented, the supervisor group name is
110+
If no further configuration is presented, the supervisor group name is
104111
generated from the "groupName" configuration option of a program.
105112

106-
Groups can override their names. This menas several programs can e.g. refer
107-
to the same group "default" but the group can be renamed if different
113+
Groups can override their names. This menas several programs can e.g. refer
114+
to the same group "default" but the group can be renamed if different
108115
applications share a common supervisor daemon.
109116

110117
This setting also provides a priority setting.
@@ -123,7 +130,7 @@ Netlogix:
123130
Renamed identifiers:
124131
--------------------
125132

126-
Both, group names and program names need to be cleaned to comply with
133+
Both, group names and program names need to be cleaned to comply with
127134
supervisors naming scheme. This is done automatically, so even if the
128-
group name is configured as `%FLOW_PATH_ROOT%` it will be transformed to
135+
group name is configured as `%FLOW_PATH_ROOT%` it will be transformed to
129136
`var-www-document-root`.

0 commit comments

Comments
 (0)