diff --git a/README.md b/README.md index 4d0a9e3..4b8d778 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # Is de FooBar open? Source code for the unofficial FooBar website. + +## Building + +This project requires both `composer` and `yarn` (`npm` might work as a +replacement) to build. + +```bash +composer update --no-dev +yarn +yarn run webpack --mode production +``` + +This will download all dependencies and compile javascript as needed. + +## Installation + +After building, you can install the project on your web server by copying +everything (except for the `node_modules`) to your server. The document root +should be `public`. + +## Configuration + +The website will attempt to load configuration from `config/config.php` and +if that doesn't work, from `config/config.sample.php`. You can create your own +configuration by copying the sample and changing parameters as needed. + +The sample configuration also contains details on the particular options. diff --git a/config/config.sample.php b/config/config.sample.php index 960737e..36fe28d 100644 --- a/config/config.sample.php +++ b/config/config.sample.php @@ -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', ];