diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9c3fcdd --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 007revad + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/how_to_schedule.md b/how_to_schedule.md new file mode 100644 index 0000000..d2e65a5 --- /dev/null +++ b/how_to_schedule.md @@ -0,0 +1,27 @@ +# How to schedule a script in Synology Task Scheduler + +To schedule a script to run on your Synology at boot-up or shut-down follow these steps: + +**Note:** You can setup a schedule task and leave it disabled, so it only runs when you select the task in the Task Scheduler and click on the Run button. + +1. Go to **Control Panel** > **Task Scheduler** > click **Create** > and select **Triggered Task**. +2. Select **User-defined script**. +3. Enter a task name. +4. Select **root** as the user (The script needs to run as root). +5. Select **Boot-up** as the event that triggers the task. +6. Leave **Enable** ticked. +7. Click **Task Settings**. +8. Optionally you can tick **Send run details by email** and **Send run details only when the script terminates abnormally** then enter your email address. +9. In the box under **User-defined script** type the path to the script. + - e.g. If you saved the script to a shared folder on volume1 called "scripts" you'd type: + - **/volume1/scripts/syno_hdd_db.sh -nr --autoupdate=3** + - For information on the options see [Options](README.md#options) +11. Click **OK** to save the settings. + +Here's some screenshots showing what needs to be set: + +


