Improve documentation.

This commit is contained in:
2019-03-13 15:57:50 +01:00
parent 8fc45011c9
commit 8e669e62f3
2 changed files with 41 additions and 5 deletions

View File

@@ -2,14 +2,23 @@
return [
/**
* The security works by checking if the request is made from an authorized IP-address.
* The security works by checking if the request is made from an
* authorized IP-address.
*
* The address is configured as an IP-address and a subnet mask. In order to verify the entire IP-address, specify
* 32 for the mask. This option only supports IPv4 for obvious reasons.
* The address is configured as an IP-address and a subnet mask. In
* order to verify the entire IP-address, specify 32 for the mask.
* This option only supports IPv4 for reasons.
*/
'security' => [
'mask' => 8,
'security' => [
'mask' => 8,
'address' => '127.0.0.1',
],
/**
* The state file is used for tracking whether the bar is open.
*
* If the file exists, the bar is considered to be open. The user
* running PHP must have write access to the directory this file
* is in.
*/
'state_file' => __DIR__ . '/open.flag',
];