summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWolfy-J <[email protected]>2018-06-14 00:04:31 +0300
committerGitHub <[email protected]>2018-06-14 00:04:31 +0300
commit0dd4ec0576539fa72f57b1f24e86d5e44a819f42 (patch)
treef5b464aeaaba921153754680341cd3e0077ca67e /README.md
parent3bcfe26dad554450dc1742da92874627697fd049 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/README.md b/README.md
index 85b1e617..71c1919f 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,68 @@ $ rr serve -v
Example [worker](https://github.com/spiral/roadrunner/blob/master/php-src/tests/http/client.php).
+Example config:
+---------------
+
+```yaml
+# rpc bus allows php application and external clients to talk to rr services.
+rpc:
+ # enable rpc server
+ enable: true
+
+ # rpc connection DSN. Supported TCP and Unix sockets.
+ listen: tcp://127.0.0.1:6001
+
+# http service configuration.
+http:
+ # set to false to disable http server.
+ enable: true
+
+ # http host to listen.
+ address: 0.0.0.0:8080
+
+ # max POST request size, including file uploads in MB.
+ maxRequest: 200
+
+ # file upload configuration.
+ uploads:
+ # list of file extensions which are forbidden for uploading.
+ forbid: [".php", ".exe", ".bat"]
+
+ # http worker pool configuration.
+ workers:
+ # php worker command.
+ command: "php psr-worker.php pipes"
+
+ # connection method (pipes, tcp://:9000, unix://socket.unix).
+ relay: "pipes"
+
+ # worker pool configuration.
+ pool:
+ # number of workers to be serving.
+ numWorkers: 4
+
+ # maximum jobs per worker, 0 - unlimited.
+ maxJobs: 0
+
+ # for how long worker is allowed to be bootstrapped. In nanoseconds for now :(
+ allocateTimeout: 600000000
+
+ # amount of time given to worker to gracefully destruct itself. In nanoseconds for now :(
+ destroyTimeout: 600000000
+
+# static file serving.
+static:
+ # serve http static files
+ enable: false
+
+ # root directory for static file (http would not serve .php and .htaccess files).
+ dir: "public"
+
+ # list of extensions for forbid for serving.
+ forbid: [".php", ".htaccess"]
+```
+
Examples:
--------