4
4
[ ![ Docs] ( https://img.shields.io/badge/docs-latest-brightgreen.svg )] ( http://recodex.github.io/cleaner/ )
5
5
[ ![ Wiki] ( https://img.shields.io/badge/docs-wiki-orange.svg )] ( https://github.com/ReCodEx/wiki/wiki )
6
6
[ ![ 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/ )
8
8
9
9
Cleaner component is tightly bound to the worker. It manages the cache folder of
10
10
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
21
21
to be run repeatedly, for example using cron, systemd timer or Windows task
22
22
scheduler. For proper function of the cleaner a suitable cron interval has to
23
23
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.
25
25
26
26
## How to run it
27
27
@@ -72,25 +72,18 @@ Generally there are two steps which has to be done to properly run cleaner servi
72
72
### Configuration
73
73
74
74
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 ` .
76
76
77
77
#### Configuration items
78
78
79
79
- ** cache-dir** -- directory which cleaner manages
80
80
- ** file-age** -- file age in seconds which is considered as outdated and will
81
81
be marked for deletion
82
82
83
- #### Example configuration
84
-
85
- ``` {.yml}
86
- cache-dir: "/tmp"
87
- file-age: "3600" # in seconds
88
- ```
89
-
90
83
### Execution
91
84
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
94
87
` *.timer ` file which can be used for croning from ` systemd ` . On Windows systems
95
88
internal scheduler should be used.
96
89
0 commit comments