Merge pull request #43 from flydev-fr/dev

fix: Patched version number

.github/workflows/releases.yml

@@ -9,6 +9,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
+      - uses: akhilmhdh/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          commit_message: "docs(contributor): readme updated"
+
       - uses: actions/checkout@v3
       - name: conventional Changelog Action
         id: changelog
@@ -24,4 +30,4 @@ jobs:
         with:
           tag_name: ${{ steps.changelog.outputs.tag }}
           release_name: ${{ steps.changelog.outputs.tag }}
-          body: ${{ steps.changelog.outputs.clean_changelog }}
+          body: ${{ steps.changelog.outputs.clean_changelog }}

Duplicator.module

@@ -137,7 +137,7 @@ class Duplicator extends WireData implements Module, ConfigurableModule
 
     return array(
       'title' => 'Duplicator',
-      'version' => $package->version,
+      'version' => '1.4.28', //$package->version,
       'summary' => '🧬 Duplicate, backup and transfer an entire site from one location to another.',
       'author' => 'flydev',
       'href' => 'https://processwire.com/talk/topic/15345-duplicator-backup-and-move-sites/',

README.md

@@ -1,12 +1,20 @@
 ![Duplicator](https://s3.us-west-2.amazonaws.com/processwire-forums/monthly_2017_11/Duplicator-logo-v2-Dlong.thumb.png.8898ec8cda79046779b10d8527fc0def.png)
 
-### Instructions
+### WIP
+
+- The readme is being re-written.
+
+# Introduction
+Duplicator will create a ZIP archive called `package` bundled with a full database backup and all your files.
+This package is stored on local disk or in the cloud and can be used to restore your site.
+You can use Duplicator to duplicate and deploy/restore your site on a new host. It can be used as backup utility. 
+
+## Install
 
 1. Download the module from the [directory](https://modules.processwire.com/modules/duplicator/) or [Github]()
 2. Drop the module files in /site/modules/Duplicator/
 3. In your admin, click Modules > Refresh
 4. Click "install" for "Duplicator"
-5. Optional. Click "install" for "Duplicator - Packages Manager"
 6. Go to Setup > Duplicator and build your package!
 
 ### SDK Installation (optional)
@@ -16,55 +24,76 @@ If you want to use `GoogleDrive` or `AmazonS3`, you have two choices of type of
 
 Installing all SDK are not required, you can choose the one you need.
 
-###### Note:
+#### Note:
 - `Dropbox` dropped support for the version 1 of the API since september 2017 - [api-v1-deprecation-timeline](https://blogs.dropbox.com/developers/2017/06/updated-api-v1-deprecation-timeline/) - so I removed it from Duplicator until I got the time to code an interface for the API v2
-- `GoogleDrive` tested the 2017-12-03 `successfully`
-- `AmazonS3` tested the 2017-12-03 `successfully`
+- `GoogleDrive` tested the 2023-03-20 `successfully` ✅
+- `AmazonS3` tested the 2017-12-03 `todo` ⏳
 
-#### Using Composer
+### Using Composer
 In the root directory of your ProcessWire installation, just type in a terminal :
 * `composer require google/apiclient`
 * `composer require aws/aws-sdk-php`
 
-#### ZIP Archive
+### ZIP Archive
 After downloading the archive, open it, you will find a folder called **`SDKs`** under each provider named directory. Extract or Upload this folder in the **`Duplicator module folder`**. If the folder already exist, merge it. Example: `/www/public_html/site/modules/Duplicator/SDKs`
 
 Download it from the [**Duplicator-SDKs**](https://github.com/flydev-fr/Duplicator-SDKs/archive/master.zip) repository.
 
-
 Now you can refresh the Duplicator's settings page, the corresponding checkbox will be enabled.
 
+# Duplicator Features
+
+## Backend Permission
+Permission set is `duplicator`. User with this permission can initiate a backup, download or sync a package. The module's settings is only accessible to `superuser`.
 
-# Installing a CRON job
+## Encryption
+- Encryption use libsodium 1.0.18 through Halite 5.0.x or 5.1 and newer
+- Version of PHP supported: PHP >= v8.x
+  Note: performance on PHP 8.0.x is poor. You must consider using PHP 8.1.x for better performance.
+
+### Windows Install
+Use `vcpkg` to install libsodium:
+  a. ``cd vcpkg
+  b. `.\bootstrap-vcpkg.bat`
+  c. `vcpkg install libsodium`
+
+You can find pre-built libraries there: https://download.libsodium.org/libsodium/releases/
+
+### Linux
+Run on terminal:
+`sudo apt-get install php8.1-sodium`
+
+Once all prequisites installed, insatll Halite by running **composer** in the root directory:
+`composer require paragonie/halite:^5`
+
+## CRON job
 Actually you have 3 choices to setup a cron job.
 
-## System CRON
-###### The standard way
+### System CRON
+#### The standard way
 To edit a crontab through the command line, type: `cronjob -e` then add for example the following line to build a package once a day :
 > `4 0 * * * php /www/mysite/wwwroot/site/modules/Duplicator/cron.php >/dev/null 2>&1`
 
-
-## PwCron
-###### modules
+### PwCron
+#### modules
 You can rely on [PwCron](https://modules.processwire.com/modules/pwcron/) to setup the job.
 > `4 0 * * * php /www/mysite/wwwroot/site/modules/PwCron/cron.php >/dev/null 2>&1`
 
-## LazyCron
-###### modules
+### LazyCron
+#### modules
 Because it's triggered by a pageview, this choice can slowdown your site - [LazyCron documentation](https://modules.processwire.com/modules/lazy-cron/)
 
-#### Notes :
-###### For Windows
+### Notes :
+#### For Windows
 Please look at this answer on stackoverflow to set up it: http://stackoverflow.com/questions/7195503/setting-up-a-cron-job-in-windows
 
-###### Using a control panel ?
+#### Using a control panel ?
 If you are running CRON via a panel, please rely on the documentation of your hosting provider. Do not hesitate to ping on the support forum thread.
 
-###### Some hosting companies don’t allow access to cron
+#### Some hosting companies don’t allow access to cron
 If this the case, you can rely on [LazyCron](https://processwire.com/api/modules/lazy-cron/) module.
 
-
-##### Example CRON delay table:
+#### Example CRON delay table:
 
 | When | Settings |
 | -------- | -------- |
@@ -78,15 +107,14 @@ If this the case, you can rely on [LazyCron](https://processwire.com/api/modules
 | Once a week |	4 0 * * 0 |
 | Once a month |	4 0 1 * * |
 
+## Cloud Backup/Store Settings
 
-# Providers Settings
-
-## GoogleDrive
+### GoogleDrive
 Obtain credentials there: [https://console.developers.google.com/apis/credentials](https://console.developers.google.com/apis/credentials)
 
 A tutorial is available on the forum :  [Duplicator Dev Thread](https://processwire.com/talk/topic/15345-duplicator-backup-and-move-sites/?page=2#comment-139376)
 
-## AmazonS3
+### AmazonS3
 Obtain credentials there: [https://console.aws.amazon.com/iam/home](https://console.aws.amazon.com/iam/home)
 
 #### Note:
@@ -98,56 +126,20 @@ A **bucket name** should conform with **DNS requirements**:
 * Cannot contain two, adjacent periods
 * Cannot contain dashes next to periods (e.g., "my-.bucket.com" and "my.-bucket" are invalid)
 
+## Issues
 
-# Issues
-
-## Timeout
+### Timeout
 Timeout usually happen if you are on a low-end budget host with limitations. The easiest way to solve this issue, is to use directory filters on some of your larger directories like your `files`, `vendor`, or even `bower_components` directory to get the size down. Then reinstall the package at the new location and then FTP all the files over that you filtered.
 
 **Hosting Provider Issue List:**
 * 1and1 Shared hosting (resolved by using Filters)
 * Dreamhost hosting (resolved using the `Archive Flush` option); Need to be tested again.
 
-# FAQ
-### GENERAL QUESTIONS
-##### What is the primary goal of this module ?
-Duplicator is a module which duplicate and deploy your website on a new host. It can be used as backup utility too.
-
-##### And how it works ?
-Duplicator will create a ZIP archive called `package` bundled with a full database backup and all your files.
-This package is stored on local disk or in the cloud and can be used to restore your website.
-The package is also used in the deployment process.
-
-##### Is it compatible with PW2 ? Guess not.
-Yes! Duplicator is compatible with ProcessWire 2.7.2, 2.8.x and 3.x.x.
-
-##### I don't use composer. Any other way to install ?
-Just download the SDK you are looking for from the repository.
-
-##### It is possible to do a manual backup without changing the module's Event trigger ?
-Yes, simply click on the "Initiate Backup Process" button from the Package Manager.
-
-##### Can I backup my site from scheduled cron job ?
-Yes, in order to get it working, you are required to install `PwCron`, then read our doc about setting up a cron job.
-
-##### I'm on windows. Will "CRON" job works ?
-Without any problem. *(Look at this answer to set up it: http://stackoverflow.com/questions/7195503/setting-up-a-cron-job-in-windows)*
-
-##### Can I exclude files or folders from a package ?
-Yes, you can exclude a single file, filter them by extension or exclude a whole folder. **Keep in mind that excluding core files or folder will not allow your deployed site to work**.
-
-##### Can I download a package after creation ?
-Yes!
-
-##### Can I manage my packages in the cloud ?
-Yes!
-
-##### Does the module screen is protected by role/user ?
-Yes, the permission set is `duplicator`. User with this permission can initiate a backup, download or sync a package. The module's settings is only accessible to `superuser`.
-
 
+<!-- readme: szabeszg,contributors,tofahrn,adrianbj -start -->
+<!-- readme: contributors -end -->
 
-## Special thanks
+# Special thanks
 - Duplicator's logo made by [@szabeszg](https://github.com/szabeszg)
 - The processwire community 💙