From 1b891e7a924839eade68844411e9896d3cb64fa8 Mon Sep 17 00:00:00 2001 From: Cody Cook Date: Wed, 29 Sep 2021 02:39:48 +0000 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 29bc59c..bd5446f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # create-system-log -A custom script for a customer that wanted to have the system download the logs every 12 hours to a share so they could transfer the logs somewhere else. \ No newline at end of file +A custom script for a customer that wanted to have the system download the logs every 12 hours to a share so they could transfer the logs somewhere else. + +# Defaults + +It will place the logs in a share called "mylogs" on volume "data" -- if it doesn't exist, it will create it automatically. It will pull the hostname and the unix timestamp. 15 minutes after the system boots and every 12 hours afterwards, the system will back up the logs and store them in the share. + +# To install the script + +Copy and paste the below command into a ReadyNAS shell. + +``` +curl -s https://gitlab.codycook.us/readynas-scripts/create-system-log/-/raw/main/create-system-log-install.sh | bash +``` +It will download the latest code and then immediately kick off a log bundle. + +Once installed, it will inform you that the installation has concluded.