diff --git a/source/manual/how-tos/cloud_backup.rst b/source/manual/how-tos/cloud_backup.rst index e5c6df3c..f7895bbf 100644 --- a/source/manual/how-tos/cloud_backup.rst +++ b/source/manual/how-tos/cloud_backup.rst @@ -2,9 +2,9 @@ Configuration Cloud Backup ========================== ------------- -Google Drive ------------- +-------------------------- +Google Drive and Nextcloud +-------------------------- **Google Drive** is a digital file storage and management service by the information technology company Google. Amongst other features, like @@ -12,6 +12,10 @@ collaborative editing of documents, spreadsheets, and presentations, it allows signed up users with an account to store and share files in the digital cloud. +**Nextcloud** is also an online storage but in contrast to Google Drive +it is intended for self hosting. You can download it freely from their +`website `__ and install it on your webserver. + The OPNsense configuration can be stored as a backup file in XML format, to your PC on an USB stick or remotely in the digital Google Drive cloud. @@ -22,7 +26,7 @@ Free online storage Because Google officially offers a free storage of 15 GB and nearly unlimited traffic, a remote backup of an OPNsense configuration file is -free of charge, the only thing you need is an account at google +free of charge, the only thing you need is an account at Google (`Google Drive Signup `__) . -------- @@ -33,13 +37,18 @@ An application programming interfaces (API) for Google Drive was released in 2013. This API empowers third-party developers to easily write apps for Google Drive. +Nextcloud is using WebDAV which works without a special library +so data can be sent directly to the server without a special client +library (for example, a file upload is just a HTTP PUT call). + ------------- Remote backup ------------- In OPNsense\ :sup:`1` you can **backup** your configuration directly and -automatically to **Google Drive**, using the new backup feature. Every -backup will be encrypted with the same algorithm used in the manual -backup so it's quite easy to restore to a new installed machine. +automatically to **Google Drive** and **Nextcloud**, using the new backup +feature. Every backup to **Google Drive** will be encrypted with the same +algorithm used in the manual backup so it's quite easy to restore to a new +installed machine. After set-up, the backup feature will do first store of the OPNsense config file and subsequently a daily new backup of changed config @@ -107,6 +116,59 @@ The moment the feature is enabled, it will do a daily compare of the last file in backup and the current configuration and creates a new backup when something has changed. + +------------------------- +Setup Nextcloud API usage +------------------------- + +1. Step Create a new user +========================= + +Click on the user icon top right and click "Users". +In the new page, enter an username and a password into the boxes and click +create to create a new user. + + +2. Step Create an Access Token +============================== + +Close the modal dialog and remove the default files. +Then open the Settings menu (also in the menu top right). +Switch to security and generate a App password. + +.. image:: images/nextcloud_create_token.png + +Copy and store the generated password. + +3. Step Connect OPNsense with Nextcloud +======================================= + +.. image:: images/nextcloud_config.png + +Scroll to the Nextcloud Section in System -> Config -> Backup and enter the +following values: + +================ ====================================================================== +Enable checked +URL Base URL of your Nextcloud installation like https://cloud.example.com +User your choosen username +Password paste your app password from step 2 +Backup Directory a name consisting of alphanumeric characters (keep default) +================ ====================================================================== + + +4. Step Verify the Configuration Upload +======================================= + +When everything worked, you will see the newly created directory after saving +the settings: + +.. image:: images/nextcloud_directory.png + +If you open it, you will see at lease a single backed up configuration file: + +.. image:: images/nextcloud_backups.png + .. rubric:: References :name: references diff --git a/source/manual/how-tos/images/nextcloud_backups.png b/source/manual/how-tos/images/nextcloud_backups.png new file mode 100644 index 00000000..67357214 Binary files /dev/null and b/source/manual/how-tos/images/nextcloud_backups.png differ diff --git a/source/manual/how-tos/images/nextcloud_config.png b/source/manual/how-tos/images/nextcloud_config.png new file mode 100644 index 00000000..903412fe Binary files /dev/null and b/source/manual/how-tos/images/nextcloud_config.png differ diff --git a/source/manual/how-tos/images/nextcloud_create_token.png b/source/manual/how-tos/images/nextcloud_create_token.png new file mode 100644 index 00000000..addb5b7f Binary files /dev/null and b/source/manual/how-tos/images/nextcloud_create_token.png differ diff --git a/source/manual/how-tos/images/nextcloud_directory.png b/source/manual/how-tos/images/nextcloud_directory.png new file mode 100644 index 00000000..fda83bc6 Binary files /dev/null and b/source/manual/how-tos/images/nextcloud_directory.png differ