omv8:omv8_plugins:scripts

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
omv8:omv8_plugins:scripts [2025/12/25 08:09] – [Add] chenteomv8:omv8_plugins:scripts [2025/12/25 08:50] (current) – [Run] chente
Line 71: Line 71:
 <html><center>Under <b>Services</b>, <b>Scripts</b>, <b>Scripts</b></center></html> <html><center>Under <b>Services</b>, <b>Scripts</b>, <b>Scripts</b></center></html>
 \\ \\
-{{ :omv8:omv8_plugins:scripts02.jpg?direct&1000 |Services Scripts Scripts}}+{{ :omv8:omv8_plugins:scripts02.png?direct&1000 |Services Scripts Scripts}}
  
   * In this form a list of the created scripts appears. Here you can create, edit, delete, or run scripts manually.   * In this form a list of the created scripts appears. Here you can create, edit, delete, or run scripts manually.
Line 78: Line 78:
  
 {{ :omv8:omv8_plugins:scripts03.png?direct&600|Add}} {{ :omv8:omv8_plugins:scripts03.png?direct&600|Add}}
-  * Press the **Add** button and in the submenu press the **Add** button to create a new script. Define: +  * **Add** button Opens a menu with the following options: 
-    * **Name**: Name used to save and execute the script. +    * **Add** – Create a new generic script. Define: 
-    * **Extension**: sh, py, etc. +      * **Name**: Name used to save and execute the script. 
-    * **Script**: Script code; you can paste from clipboard. +      * **Extension**: sh, json, php, etc. 
-    * **Testing arguments**: Optional arguments for execution from the Scripts tab only. +      * **Script**: Script code; you can paste from clipboard. 
-  * Press **Save**. +      * **Testing arguments**: Optional arguments for execution from the Scripts tab only. 
-    * The script is stored in the OMV database.+    * **Add Python** – Create a new Python script. 
 +    * **Add from URL** – Create a script by fetching it from a URL. 
 +    * **Import** – Import multiple scripts from the server filesystem. 
 +    * **Import one** – Import a single script from the server filesystem. 
 +    * **Sync changes from file** – Update the script in the database with modifications made in the file copy. 
 +  * The script is stored in the OMV database.
     * A copy is saved in the shared folder defined in the Settings tab.     * A copy is saved in the shared folder defined in the Settings tab.
     * A line with the script data appears in the Scripts form.     * A line with the script data appears in the Scripts form.
-  * Press the **Add** button and use **Import** to import multiple scripts from the server file system. 
-  * Press the **Add** button and use **Import one** to import a single script from the server file system. 
  
 === Edit === === Edit ===
  
-  * Select a script and press **Edit** to modify script body and arguments. +  * Select a script and press **Edit**. Modify the script and/or arguments, then press **Save** or **Cancel**.
-  * Press **Save** to save changes, **Cancel** to exit without saving.+
  
 === Delete === === Delete ===
  
-  * Select a script and press **Delete** to remove it from the OMV database and the backup folder.+  * Select a script and press **Delete**. This removes it from the database and shared folder. 
 + 
 +=== Check using Shellcheck or Pylint === 
 + 
 +  * Run syntax/style checks depending on script type.
  
 === Run === === Run ===
  
-{{ :omv8:omv8_plugins:scripts04.jpg?direct&600|Run}}+{{ :omv8:omv8_plugins:scripts04.png?direct&600|Run}}
   * Select a script and press **Run** to manually execute it.   * Select a script and press **Run** to manually execute it.
     * A code box shows execution output.     * A code box shows execution output.
Line 107: Line 113:
  
 <html><body><table width="100%" border="0"><tr><td colspan="2" style="background-color:#69A5FF;height:30px;"><strong><span style="color:#FFFFFF;font-size:110%;">&#160; Note <html><body><table width="100%" border="0"><tr><td colspan="2" style="background-color:#69A5FF;height:30px;"><strong><span style="color:#FFFFFF;font-size:110%;">&#160; Note
-</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">+</span></strong></td></tr><tr><td style="background-color:#E6FEFF;padding:10px;width:380px;">
 In this dialog box the output of the script will be displayed.<br> In this dialog box the output of the script will be displayed.<br>
 Dialogs generated with Bash Dialog or similar cannot be interacted with or displayed. Dialogs generated with Bash Dialog or similar cannot be interacted with or displayed.
 </tr></table></body></html> </tr></table></body></html>
 +
 +=== Git ===
 +
 +  * Manage scripts versioned in a Git repository.
  
 === Docs === === Docs ===
Line 122: Line 132:
 <html><center>Under <b>Services</b>, <b>Scripts</b>, <b>Schedule</b></center></html> <html><center>Under <b>Services</b>, <b>Scripts</b>, <b>Schedule</b></center></html>
 \\ \\
-{{ :omv8:omv8_plugins:scripts05.jpg?direct&1000 |Services Scripts Schedule}}+{{ :omv8:omv8_plugins:scripts05.png?direct&1000 |Services Scripts Schedule}}
  
   * Displays a list of created scheduled jobs. You can create, edit, delete, or run them manually.   * Displays a list of created scheduled jobs. You can create, edit, delete, or run them manually.
Line 128: Line 138:
 === Create === === Create ===
  
-{{ :omv8:omv8_plugins:scripts06.jpg?direct&600|Schedule}}+{{ :omv8:omv8_plugins:scripts06.png?direct&600|Schedule}}
   * Press **Create** to define a script schedule:   * Press **Create** to define a script schedule:
     * **Enabled**: Activate scheduled execution.     * **Enabled**: Activate scheduled execution.
  • omv8/omv8_plugins/scripts.1766650184.txt.gz
  • Last modified: 2025/12/25 08:09
  • by chente