Skip to content

Commit 0131021

Browse files
committed
Tweak readme
1 parent 7b62afe commit 0131021

File tree

1 file changed

+5
-12
lines changed

1 file changed

+5
-12
lines changed

README.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](http://recodex.github.io/cleaner/)
55
[![Wiki](https://img.shields.io/badge/docs-wiki-orange.svg)](https://github.com/ReCodEx/wiki/wiki)
66
[![GitHub release](https://img.shields.io/github/release/recodex/cleaner.svg)](https://github.com/ReCodEx/wiki/wiki/Changelog)
7-
[![COPR](https://copr.fedorainfracloud.org/coprs/semai/ReCodEx/package/recodex-cleaner/status_image/last_build.png)]()
7+
[![COPR](https://copr.fedorainfracloud.org/coprs/semai/ReCodEx/package/recodex-cleaner/status_image/last_build.png)](https://copr.fedorainfracloud.org/coprs/semai/ReCodEx/)
88

99
Cleaner component is tightly bound to the worker. It manages the cache folder of
1010
the worker, mainly deletes outdated files. Every cleaner instance maintains one
@@ -21,7 +21,7 @@ It is a simple script which checks the cache folder, possibly deletes old files
2121
to be run repeatedly, for example using cron, systemd timer or Windows task
2222
scheduler. For proper function of the cleaner a suitable cron interval has to
2323
be used. It is recommended to use 24 hour interval which is sufficient enough for
24-
intended usage. The value is set in the configuration file of the cleaner.
24+
intended usage.
2525

2626
## How to run it
2727

@@ -72,25 +72,18 @@ Generally there are two steps which has to be done to properly run cleaner servi
7272
### Configuration
7373

7474
The default location for cleaner configuration file is
75-
`/etc/recodex/cleaner/config.yml`.
75+
`/etc/recodex/cleaner/config.yml`. Example configuration file can be found in `cleaner/install/config.yml`.
7676

7777
#### Configuration items
7878

7979
- **cache-dir** -- directory which cleaner manages
8080
- **file-age** -- file age in seconds which is considered as outdated and will
8181
be marked for deletion
8282

83-
#### Example configuration
84-
85-
```{.yml}
86-
cache-dir: "/tmp"
87-
file-age: "3600" # in seconds
88-
```
89-
9083
### Execution
9184

92-
As stated before cleaner should be croned, on linux systems this can be done by
93-
built in `cron` service or if there is `systemd` present cleaner itself provides
85+
As stated before cleaner should be run in cron, on linux systems this can be done by
86+
built in `cron` service or if there is `systemd` present, cleaner itself provides
9487
`*.timer` file which can be used for croning from `systemd`. On Windows systems
9588
internal scheduler should be used.
9689

0 commit comments

Comments
 (0)