Add configuration snippet to showcase env vars
[m6w6/gh-mirror] / README.md
index f93e5ba60ebcabbbaaec840692713c87b7ad7afe..6c3c7925b48ce39e6ad5268f100b05588e9710cd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,6 +6,14 @@ Simple PHP webhook to mirror github repositories.
 
 * [pecl/http](https://github.com/m6w6/ext-http)
 
 
 * [pecl/http](https://github.com/m6w6/ext-http)
 
+## Configuration
+
+```php
+$mirror = getenv("mirror") ?: "/var/github/mirror";
+$secret = getenv("secret") ?: trim(file_get_contents("$mirror/.secret"));
+$owners = explode(",", getenv("owners") ?: trim(file_get_contents("$mirror/.owners")));
+```
+
 ## License
 
 gh-mirror is licensed under the 2-Clause-BSD license, which can be found in
 ## License
 
 gh-mirror is licensed under the 2-Clause-BSD license, which can be found in