Rooba
/
odyssey
mirror of https://github.com/yandex/odyssey.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

odyssey: update documentation

This commit is contained in:
Dmitry Simonenko 2018-07-02 18:57:01 +03:00
parent fb023d42cb
commit 99701da211
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -89,6 +89,7 @@ make
* [include](documentation/configuration.md#include-string)
* [daemonize](documentation/configuration.md#daemonize-yesno)
* [pid\_file](documentation/configuration.md#pid_file-string)
* [unix\_socket\_dir](documentation/configuration.md#unix_socket_dir-string)
##### Logging

16
documentation/configuration.md
View File

@ -23,6 +23,16 @@ the specified file at startup.
`pid_file "/var/run/odyssey.pid"`
#### unix\_socket\_dir *string*
UNIX socket directory.
If `unix_socket_dir` is specified, Odyssey will enable UNIX socket
communications. Specified directory path will be used for
searching socket files.
`unix_socket_dir "/tmp"`
#### log\_file *string*
If log\_file is specified, Odyssey will additionally use it to write
@ -242,6 +252,9 @@ Odyssey will fail in case it could not bind on any resolved address.
#### host *string*
If host is not set, Odyssey will try to listen using UNIX socket if
`unix_socket_dir` is set.
`host "*"`
#### port *integer*
@ -310,6 +323,9 @@ Set storage type to use. Supported types:
Remote server address.
If host is not set, Odyssey will try to connect using UNIX socket if
`unix_socket_dir` is set.
#### port *integer*
Remote server port.