installation and configuration

master
Martin Polanka 8 years ago
parent 7aaeb9389c
commit b3507d8c87

@ -328,8 +328,34 @@ There is a bit of catch with cleaner service, to work properly, server filesyste
To install and use the cleaner, it's necessary to have **Python** and **Pip** in version 3 installed.
* Firstly dependencies of cleaner has to be installed:
```
pip install -r requirements.txt
```
### Configuration and usage
#### Fedora (and other RPM distributions)
- run `python setup.py bdist_rpm --post-install ./cleaner/install/postinst` to generate binary `.rpm` package
- install package using `sudo dnf install ./dist/recodex-cleaner-0.1.0-1.noarch.rpm` (depends on actual version)
#### Other Linux systems
- run installation as `python setup.py install --install-scripts /usr/bin`
- run postinst script as root with `sudo ./cleaner/install/postinst`
#### Windows
- start `cmd` with administrator permissions
- decide in which folder cleaner should be installed, `C:\Program Files\ReCodEx\cleaner` is assumed
- run installation with `python setup.py install --install-scripts "C:\Program Files\ReCodEx\cleaner"` where path specified with `--install-scripts` can be changed
- copy configuration file alongside with installed executable using `copy install\config.yml "C:\Program Files\ReCodEx\cleaner\config.yml"`
### Configuration and usage
#### Configuration items
- **cache-dir** - directory which cleaner manages
- **file-age** - file age in seconds which are considered outdated and will be deleted
#### Example configuration
```
cache-dir: "/tmp"
file-age: "3600" # in seconds
```
#### Usage
Loading…
Cancel
Save