| Both sides previous revision Previous revision Next revision | Previous revisionLast revisionBoth sides next revision |
| remote_mount_plugin_for_omv5 [2021/02/12 22:20] – crashtest | remote_mount_plugin_for_omv5 [2022/07/28 17:24] – crashtest |
|---|
| <html><center><strong>Remote Mount For OMV5 - Addendum D</strong></center></html> | <html><center><span style="color:#000066;font-size:300%;">Remote Mount For OMV5</span></center></html> |
| |
| {{ :omvextras_logo4.jpg?400 |}} | {{ :omvextras_logo4.jpg?400 |}} |
| \\ | \\ |
| \\ | \\ |
| If preferred, this document is available in PDF form at this location → [[https://github.com/OpenMediaVault-Plugin-Developers/docs/blob/master/Adden-D-Remote_Mount_Plugin.pdf|Adden-D Remote Mount Plugin]] | This document can be converted to a PDF file, in the user's language of choice (see the following), on Windows, Mac's and popular Linux desktop platforms. Simply select the printer icon on the upper right corner of this web page. When prompted at the client, select “print to PDF”, name and save the file. |
| \\ | \\ |
| {{ :underconstruction.jpg?400 |}} | \\ |
| | [[https://translate.google.com/|Google Translate]] kann Wiki-Dokumente in Ihre Sprache übersetzen. Fügen Sie die Wiki-URL in das linke Fenster ein und öffnen Sie den übersetzten Link rechts.\\ |
| | [[https://translate.google.com/|Google Translate]] puede traducir documentos wiki a su idioma. Pegue la URL de la wiki en la ventana izquierda y abra el enlace traducido a la derecha.\\ |
| | [[https://translate.google.com/|Google Translate]] peut traduire des documents wiki dans votre langue. Collez l'url du wiki dans la fenêtre de gauche et ouvrez le lien traduit sur la droite.\\ |
| | [[https://translate.google.com/|Google]]翻訳はwikiドキュメントをあなたの言語に翻訳することができます。 左側のウィンドウにwikiのURLを貼り付け、右側の翻訳されたリンクを開きます。\\ |
| \\ | \\ |
| ===== The Remote Mount Plugin ===== | ===== The Remote Mount Plugin ===== |
| ===== Uses for Remote Mount ===== | ===== Uses for Remote Mount ===== |
| |
| Remote Mount is useful for mounting, accessing and replicating network shares, located on another LAN server or a LAN client. This capability works very well with Rsync, for backing up network shares over a LAN connection. | * Remote Mount is useful for mounting, accessing and replicating network shares, located on another LAN server or a LAN client. This capability works very well with Rsync, for backing up network shares over a LAN connection. |
| \\ | * Along with setting up Remote Mount, this document will provide a practical example where Remote Mount and Rsync are used for replicating a network share. |
| \\ | * **Remote Mount makes the creation of a full Backup Server relatively easy**, with no command line operations required. Guidance for creating a full Backup Server is provided in this document. |
| Along with setting up Remote Mount, this document will provide a practical example where Remote Mount and Rsync are used for replicating a network share. | |
| \\ | |
| \\ | |
| ===== Install the Remote Mount Plugin ===== | ===== Install the Remote Mount Plugin ===== |
| |
| ---- | ---- |
| |
| On the Primary server; under **Access Rights Management**, **Shared Folders**; click on the **Music** shared folder and the **ACL** button. | **On the Primary server**:\\ |
| | \\ |
| | Under **Access Rights Management**, **Shared Folders**; click on the **Music** shared folder and the **ACL** button. |
| \\ | \\ |
| \\ | \\ |
| \\ | \\ |
| \\ | \\ |
| For users who are interested only in mounting a remote share, this concludes the installation, configuration, of the Remote Mount plugin. | For users who are interested only in mounting a remote share, this concludes the installation and configuration of the Remote Mount plugin. |
| \\ | \\ |
| {{ :divider2.png?800 |}} | {{ :divider2.png?800 |}} |
| ---- | ---- |
| \\ | \\ |
| Now we have two shared folders. At this point, it's becoming obvious why using something to annotate “**remote**” ( **_R** ), in the shared folder name helps to prevent confusion. With a pair of shared folders, one **local** and the other **remote**, the two can be rsycn'ed. | Now we have two shared folders. At this point, it's becoming obvious why using something to annotate “**remote**” ( **_R** ), in the shared folder name helps to prevent confusion. With a pair of shared folders, one **local** and the other **remote**, the two can be rsync'ed. |
| \\ | \\ |
| |
| |
| |
| ===== Setting up an Rsycn Job ===== | ===== Setting up an Rsync Job ===== |
| \\ | \\ |
| |
| First note that the job type is **Local**. (When using Remote Mount, an Rsycn server is **not** required.) | First note that the job type is **Local**. (When using Remote Mount, an Rsync server is **not** required.) |
| \\ | \\ |
| \\ | \\ |
| \\ | \\ |
| \\ | \\ |
| It's necessary to change ownership (**chown**) to the local root account and the local users group, and to modify access permissions (**chmod**). In this case **--chmod=0775** and **--chown=root:users** was used. This is the equivalent of: | It's necessary to change ownership (**chown**) to the local root account and the local users group, and to modify access permissions (**chmod**). In this case ''−−chmod=0775'' and ''−−chown=root:users'' was used. This is the equivalent of: |
| \\ | \\ |
| \\ | \\ |
| \\ | \\ |
| | |
| * After the first replication event is complete, in subsequent jobs, rsync will only transfer new and changed files. This makes rsycn very efficient and fast. | * After the first replication event is complete, in subsequent jobs, rsync will only transfer new and changed files. This makes rsync very efficient and fast. |
| * In the Rsync Job's options, with the “**Keep Partially Transferred Files**” switch **ON**, even if a job is interrupted with a reboot or for some another reason, transferred files are not lost. | * In the Rsync Job's options, with the “**Keep Partially Transferred Files**” switch **ON**, even if a job is interrupted with a reboot or for some another reason, transferred files are not lost. |
| * Turning the **Delete** switch **OFF**, may provide some degree of protection against accidentally deleted files. However, it will be necessary to manually turn the Delete switch on, from time to time, to purge unwanted files. | * Turning the **Delete** switch **OFF**, may provide some degree of protection against accidentally deleted files. However, it will be necessary to manually turn the Delete switch on, from time to time, to purge unwanted files. |
| * If permissions are used, duplicate all usernames and passwords that are resident on the Primary Server, on the Backup Server. Usernames and passwords must be an exact match. | * If permissions are used, duplicate all usernames and passwords that are resident on the Primary Server, on the Backup Server. Usernames and passwords must be an exact match. |
| * Check the Primary Server's permissions for each share, on both the shared folder and on the SMB share, and duplicate them on the Backup Server. Permissions should match throughout. | * Check the Primary Server's permissions for each share, on both the shared folder and on the SMB share, and duplicate them on the Backup Server. Permissions should match throughout. |
| * The permissions applied in the rsync job Extra options, to adjust incoming foreign files permissions, should match permissions set on the local shared folder. Understanding the “Octal” required for chmod or using WinSCP to determine the Octal to use (as demo'ed in Further Notes on Permission Commands), is important for transparent user access to backup shares, when the Backup server is brought on-line. | * The permissions applied in the rsync job **Extra options**, to adjust incoming foreign files permissions, should match permissions set on the local shared folder. Understanding the “**Octal**” required for **chmod** or using [[https://winscp.net/eng/download.php|WinSCP]] to determine the Octal to use (demo'ed in [[https://wiki.omv-extras.org/doku.php?id=remote_mount_plugin_for_omv5#further_notes_on_permission_commands|Further Notes on Permission Commands]] ), is important for transparent user access to backup shares, when the Backup server is brought on-line. |
| * When the Backup Server is activated, all rsync jobs on the Backup Server should be deactivated/disabled immediately. Share replication should not be re-enabled until the Primary Server is repaired and newly created user files are transferred from the Backup Server, to the Primary Server. | * Before the Backup Server is activated, **all rsync jobs** on the Backup Server should be **disabled**. Share replication should not be re-enabled until the Primary Server is repaired and newly created user files are transferred from the Backup Server, to the Primary Server. |
| * Changes involving shares, permissions, etc., made on the Primary Server should be duplicated on the Backup Server. | * Changes involving shares, permissions, etc., made on the Primary Server should be duplicated on the Backup Server. |
| * If a user's workstation password is changed, the password for the same username much changed on the Primary Server AND the Backup server to maintain transparent access. | * If a user's workstation password is changed, the password for the same username much changed on the Primary Server AND the Backup server to maintain transparent access. |
| * Turning the Delete switch off, in rsync jobs, may provide some accidental delete protection. However, from time to time, it will be necessary to turn the switch ON and run a job to purge unwanted files. | * Turning the Delete switch **off**, in rsync jobs, may provide some accidental delete protection. However, from time to time, it will be necessary to turn the switch ON and run a job to purge unwanted files. |
| |
| ---- | ---- |
| |
| ==== Use Cases ==== | ==== Use Cases ==== |
| \\ | |
| \\ | |
| === Home Users: === | === Home Users: === |
| \\ | |
| |
| For home use, where files are largely static, home admin's should consider a replication interval of once a week or every two weeks. The reasoning is, a reasonable time interval is needed to discover a data disaster on the Primary server and turn off share replication, before the problem is replicated to the Backup Server. | For home use, where files are largely static, home admin's should consider a replication interval of once a week or every two weeks. The reasoning is, a reasonable time interval is needed to discover a data disaster on the Primary server and turn off share replication, before the problem is replicated to the Backup Server. |
| \\ | \\ |
| \\ | \\ |
| While not for beginners, setting up automated and self purging snapshots is within the capability of a Computer or Linux enthusiast. This document [[https://github.com/OpenMediaVault-Plugin-Developers/docs/blob/master/HOWTO-Automated%20ZFS%20snapshots.pdf|HOW-TO: Setup automated, Self Rotating and Purging ZFS snapshots]] details the processes for setting up automated snapshots using zfs-auto-snapshot . | While not for beginners, setting up automated and self purging snapshots is within the capability of a Computer or Linux enthusiast. [[https://github.com/OpenMediaVault-Plugin-Developers/docs/blob/master/HOWTO-Automated%20ZFS%20snapshots.pdf|HOW-TO: Setup automated, Self Rotating and Purging ZFS snapshots]] details the processes for setting up automated snapshots using zfs-auto-snapshot . |
| |
| ---- | ---- |
| \\ | \\ |
| * Log into OMV's GUI, on the **Backup Server**. | * Log into OMV's GUI, on the **Backup Server**. |
| * Under **Services**, **Rsycn**, in the **Jobs** tab, select the top Rsync job, and click the **Edit** button. At the top of the dialog box, change the **Enabled** switch from ON (green) to **OFF** (gray). Proceed down the list, turning **ALL rsync jobs OFF**. | * Under **Services**, **Rsync**, in the **Jobs** tab, select the top Rsync job, and click the **Edit** button. At the top of the dialog box, change the **Enabled** switch from ON (green) to **OFF** (gray). Proceed down the list, turning **ALL rsync jobs OFF**. |
| * Under **Services**, **SMB/CIF**, in the **Settings** Tab under **General Settings**, set **Enable** to **ON** (green). | * Under **Services**, **SMB/CIF**, in the **Settings** Tab under **General Settings**, set **Enable** to **ON** (green). |
| * Notify users to use the Backup Server until further notice. | * Notify users to use the Backup Server until further notice. |
| | * On the **Primary Server**, under **Services**, **SMB/CIF**, **Settings** Tab, **General Settings**, **disable SMB** (off - gray) to avoid user confusion. |
| |
| \\ | \\ |
| ===== The Bottom Line ===== | ===== The Bottom Line ===== |
| \\ | \\ |
| The Remote Mount Plugin and Openmediavault's standard features make it relatively easy and inexpensive to setup 100% backup of a Primary Server's entire data store, with a second hard drive of adequate size. The platform could be a low cost SBC, an I386 or an amd64 PC. | The Remote Mount Plugin and Openmediavault's standard features make it relatively easy and inexpensive to setup 100% backup of a Primary Server's entire data store, with a second hard drive or an array of adequate size. The platform could be a low cost SBC, an I386 or an amd64 PC. |
| {{ :divider2.png?800 |}} | {{ :divider2.png?800 |}} |
| |
| **chown** is used to reset ownership and group access on incoming foreign files.\\ | **chown** is used to reset ownership and group access on incoming foreign files.\\ |
| In the following, the left hand side of the colon is the “Owner” (**root**). The right hand side of the colon is the “Group” (in this case **users**).\\ | In the following, the left hand side of the colon is the “Owner” (**root**). The right hand side of the colon is the “Group” (in this case **users**).\\ |
| ''--chown=root:users''\\ | ''−−chown=root:users''\\ |
| \\ | \\ |
| **Others**, not part of the command, is any username that is NOT specifically called out as the “owner” or any member of the group “users”.\\ | **Others**, not part of the command, is any username that is NOT specifically called out as the “owner” or any member of the group “users”.\\ |
| **chmod** is used to define the permissions applied to the Owner, the Group, and others.\\ | **chmod** is used to define the permissions applied to the Owner, the Group, and others.\\ |
| \\ | \\ |
| ''--chmod=0775'' | ''−−chmod=0775'' |
| |
| On the Primary (remote) server, [[https://winscp.net/eng/download.php|WinSCP]] can be used to determine the permissions and settings needed for incoming files, as shown below. (Details for setting up WinSCP are available → [[https://openmediavault.readthedocs.io/en/5.x/new_user_guide/newuserguide.html#winscp|here]].) The “Octal” 0775 are permissions that directly correspond to: | On the Primary (remote) server, [[https://winscp.net/eng/download.php|WinSCP]] can be used to determine the permissions and settings needed for incoming files, as shown below. (Details for setting up WinSCP are available → [[https://openmediavault.readthedocs.io/en/5.x/new_user_guide/newuserguide.html#winscp|here]].) The “Octal” 0775 are permissions that directly correspond to: |
| |
| (OMV's standard Linux permissions)\\ | (OMV's standard Linux permissions)\\ |
| **Owner: root - Read/Write/Execute**\\ | **Owner: root - Read/Write/eXecute**\\ |
| **Group: users - Read/Write/Execute**\\ | **Group: users - Read/Write/eXecute**\\ |
| **Others: Read/Execute**\\ | **Others: Read/eXecute**\\ |
| \\ | \\ |
| {{ ::remotemount17.jpg?600 |}} | {{ ::remotemount17.jpg?600 |}} |