sftp-push-sync 2.1.3 → 2.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -88,10 +88,11 @@ Create a `sync.config.json` in the root folder of your project:
88
88
  }
89
89
  }
90
90
  },
91
+ "parallelScan": true,
91
92
  "cleanupEmptyDirs": true,
92
93
  "include": [],
93
94
  "exclude": ["**/.DS_Store", "**/.git/**", "**/node_modules/**"],
94
- "textExtensions": [".html",".xml",".txt",".json",".js",".css",".md",".svg"],
95
+ "textExtensions": [".shtml",".xml",".txt",".json",".js",".css",".md",".svg"],
95
96
  "mediaExtensions": [".jpg",".jpeg",".png",".webp",".gif",".avif",".tif",".tiff",".mp4",".mov",".m4v","mp3",".wav",".flac"],
96
97
  "progress": {
97
98
  "scanChunk": 10,
@@ -150,6 +151,20 @@ If you have stored the scripts in `package.json` as follows:
150
151
 
151
152
  The dry run is a great way to compare files and fill the cache.
152
153
 
154
+ ### How ist works
155
+
156
+ There are 7 steps to follow:
157
+
158
+ - Phase 1: Scan local files
159
+ - Phase 2: Scan remote files
160
+ - Phase 3: Compare & decide
161
+ - Phase 4: Removing orphaned remote files
162
+ - Phase 5: Preparing remote directories
163
+ - Phase 6: Apply changes
164
+ - Phase 7: Cleaning up empty remote directories
165
+
166
+ Phases 1 and 2 can optionally be executed in parallel. Phase 6 always runs in parallel with as many worker threads as the FTP server allows.
167
+
153
168
  ### Sidecar uploads / downloads
154
169
 
155
170
  A list of files that are excluded from the sync comparison and can be downloaded or uploaded separately.