omv8:omv8_plugins:symlinks [omv-extras.org]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
\\
<html><center><b>Symlinks Plugin For OMV8</b></center></html>

[[omv8:omv8_plugins:symlinks|{{ ::omv7:omv7_plugins:symlinks-logo.jpg?400 |Symlinks Plugin For OMV8}}]]

====== Symlinks Plugin For OMV8 ======
\\
\\

===== Summary =====

  * **openmediavault-symlinks** provides a simple way to create and manage symbolic links directly from the OpenMediaVault GUI.
    * A symlink can be used to shorten long and complex mount paths, such as disks mounted by UUID.
    * For example, a typical OMV mount path looks like this:
      * ''/srv/dev-disk-by-uuid-b20c0ff5-6d6b-4a5d-a20a-1e8888269329/''
    * You can create a symlink in the OMV root path, for example:
      * ''/disk1''
    * This makes it much easier to reference disk paths in applications such as containers, where you only need to use /disk1.
    * This plugin is especially useful when working with Docker or other containerized applications, as it provides stable and readable paths independent of disk UUIDs.

----

===== Prerequisites =====

  * [[https://wiki.omv-extras.org/doku.php?id=misc_docs:omv_extras|OMV-Extras]] must be pre-installed.

----

===== Installation =====

In OMV8's GUI:\\
Under **System**, **Plugins**, find and highlight **openmediavault-symlinks 8.X**, and click the **Install** button.

----

===== Using the Symlinks plugin =====

<html><center>Under <b>Services</b>, <b>Symlinks</b></center></html>
\\
{{ :omv8:omv8_plugins:symlinks1.png?direct&1000 |Services Symlinks}}

----

=== Create and delete a symlink ===

{{ :omv8:omv8_plugins:symlinks2.png?direct&600|Create symlink}}

  * Go to **Services** > **Symlinks** and press the **+ Create** button. In the dialog window, do the following:
    * The **Source** field defines the actual folder on the file system. Click the folder icon on the right, locate the folder for which the symlink will be created, and select it.  
      * In the previous example, this would be:  
        * ''/srv/dev-disk-by-uuid-b20c0ff5-6d6b-4a5d-a20a-1e8888269329/''
    * The **Destination** field defines where the symlink will be created and the name it will have. You can use the folder selector or enter the path manually.  
      * In this example, enter:  
        * ''/disk1''
    * Press **Save**. The symlink is created.
  * To delete a symlink, select it from the list and press the **Delete** button.

----

=== Import existing symlinks in the system ===

  * You can import symlinks that were created manually from the CLI so they appear in the OMV GUI.
  * Press the **Import existing symlinks** button.
  * Existing symlinks found on the system will appear in a drop-down list. Select the one you want and press **Import**.
  * A new entry will appear in the list with the imported symlink.

----

===== Source Code =====

-> [[https://github.com/OpenMediaVault-Plugin-Developers/openmediavault-symlinks|openmediavault-symlinks]]

----

===== A Closing Note =====

We, who support the openmediavault project, hope you’ve found this guide to be useful and that you’ll find your openmediavault server to be efficient, easy to use, and enjoyable.\\
\\
If you found this plugin guide to be helpful, please consider a modest donation to support the hosting costs of this server.\\
\\
**OMV-Extras.org**
\\
<html>
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
<input type="hidden" name="cmd" value="_s-xclick">
<input type="hidden" name="hosted_button_id" value="2BQNGSC8HQJME">
<input type="image" src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" name="submit" title="PayPal - The safer, easier way to pay online!" alt="Donate with PayPal button" border="0">
<img alt="" src="https://www.paypal.com/en_US/i/scr/pixel.gif" width="1" height="1" border="0">
</form>
</html>
\\
\\
**Venmo: ryecoaaron** \\