extend README.md
This commit is contained in:
21
README.md
21
README.md
@@ -2,7 +2,7 @@
|
||||
A daemon to monitore filesystems events with inotify on Linux and execute tasks, which can be Python functions or shell commands.
|
||||
|
||||
## Dependencies
|
||||
[pyinotify](https://github.com/seb-m/pyinotify)
|
||||
* [pyinotify](https://github.com/seb-m/pyinotify)
|
||||
|
||||
## Installation
|
||||
* Install pyinotifyd with pip.
|
||||
@@ -10,3 +10,22 @@ A daemon to monitore filesystems events with inotify on Linux and execute tasks,
|
||||
pip install pyinotifyd
|
||||
```
|
||||
* Modify /etc/pyinotifyd/config.py according to your needs.
|
||||
|
||||
## Global configuration
|
||||
The config file is written in Python syntax. pyinotifyd reads config options from a dictionary named **pyinotifyd_config**.
|
||||
This is the default configuration:
|
||||
```python
|
||||
pyinotifyd_config = {
|
||||
"watches": [],
|
||||
"loglevel": logging.INFO,
|
||||
"shutdown_timeout": 30
|
||||
}
|
||||
```
|
||||
|
||||
Global options:
|
||||
* **watches**
|
||||
List of Watches, description below.
|
||||
* **loglevel**
|
||||
Set the loglevel, you may use every available loglevel of the Python logging framework.
|
||||
* **shutdown_timeout**
|
||||
Timeout to wait for pending tasks to complete when shutdown.
|
||||
|
||||
Reference in New Issue
Block a user