modify readme

This commit is contained in:
Bofh 2020-11-19 22:09:14 +01:00
parent 9d59a2b0c4
commit 22989c624f
1 changed files with 12 additions and 3 deletions

View File

@ -1,4 +1,4 @@
# yacy-maintenance-scripts
# YaCy Maintenance Scripts
Scripts for easily maintaining your YaCy instance
@ -9,6 +9,15 @@ Scripts for easily maintaining your YaCy instance
- Using "yacynet" as docker container name
- Default Solr collection must be called "collection1"
This requirements are basic to make this scripts function right out of the box.
You can make any modifications to the scripts to suit your needs (in case you don't use docker or have different parameters)
This requirements are basic to **make this scripts work right out of the box**.
You can make **any modifications to the scripts** to suit your needs (in case you don't use docker or have different parameters)
## Installation
Just **clone the repo somewhere** on your server
## Usage
Execute the wrapper scripts located at `x/`, depending on the **action you want to do**.
This scripts can also be **called into a cron job** directly