wordmove-ng 6.0.0 → 6.0.2

data/docs/index.md

@@ -0,0 +1,59 @@
+---
+title: Introduction
+nav_order: 1
+permalink: /
+---
+
+# wordmove-ng
+{: .fs-9 }
+
+Move WordPress sites between environments with one command: files and database, in both directions, over SSH.
+{: .fs-6 .fw-300 }
+
+[Install]({{ site.baseurl }}/installation/){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
+[Quick start]({{ site.baseurl }}/quick-start/){: .btn .fs-5 .mb-4 .mb-md-0 .mr-2 }
+[Upgrading from 5.x]({{ site.baseurl }}/upgrading/){: .btn .fs-5 .mb-4 .mb-md-0 }
+
+---
+
+wordmove-ng pushes or pulls the WordPress core, uploads, themes, plugins, mu-plugins, languages and the database between a local install and any number of remote hosts. Files travel with `rsync`; the database is dumped at the source, imported at the target and adapted there with `wp search-replace`, so URLs and paths always match the destination.
+
+It is the maintained, independent successor of [Wordmove](https://github.com/welaika/wordmove) by weLaika, continued through the [kokiddp fork](https://github.com/kokiddp/wordmove). The `movefile.yml` format, the commands and the flags are unchanged; the internals were modernised and a few unsafe behaviours removed. If you come from either project, read [Upgrading from wordmove 5.x]({{ site.baseurl }}/upgrading/).
+
+## How it works
+
+```
+                 push  ───────────────▶
+   local  ┌────────────┐            ┌────────────┐  remote
+          │ wordpress  │   rsync    │ wordpress  │
+          │ wp-content │ ─────────▶ │ wp-content │
+          │            │ ◀───────── │            │
+          │ database   │  dump/scp  │ database   │
+          └────────────┘            └────────────┘
+                 ◀───────────────  pull
+```
+
+- Every remote operation uses the system `ssh`, `scp` and `rsync`. Your ssh-agent, `~/.ssh/config`, jump hosts and modern key types all work exactly as on the command line, and nothing breaks on a new OpenSSL or Ruby release.
+- The **source** database is only ever read. Both directions dump the source, import on the target, then run `wp search-replace` on the target. A backup of the target database is taken first.
+- Prerequisites on both sides are probed before any backup, dump or import, so a misconfigured host fails before it can do harm. `wordmove-ng doctor` performs the same checks on demand.
+- Optional [maintenance mode]({{ site.baseurl }}/database-sync/#maintenance-mode) hides the database replacement from visitors.
+- MariaDB and MySQL are both supported, with sandbox-header handling, collation and charset normalisation, socket and port support.
+- Runs on Ruby 3.0 through 4.0.
+
+## Where to go next
+
+| I want to… | Read |
+| --- | --- |
+| install it | [Installation]({{ site.baseurl }}/installation/) |
+| sync my first site | [Quick start]({{ site.baseurl }}/quick-start/) |
+| move from `wordmove` 5.x | [Upgrading]({{ site.baseurl }}/upgrading/) |
+| understand every `movefile.yml` key | [Configuration]({{ site.baseurl }}/configuration/) |
+| know what each flag does | [Usage and flags]({{ site.baseurl }}/usage/) |
+| know exactly what happens to my database | [Database sync]({{ site.baseurl }}/database-sync/) |
+| run commands before or after a deploy | [Hooks]({{ site.baseurl }}/hooks/) |
+| schedule syncs from cron or CI | [Automation and cron]({{ site.baseurl }}/automation/) |
+| fix a problem | [Troubleshooting]({{ site.baseurl }}/troubleshooting/) |
+
+## Credits
+
+Wordmove was created and maintained for a decade by [weLaika](https://dev.welaika.com): Stefano Verna, Ju Liu, Fabrizio Monti, Alessandro Fazzi, Filippo Gangi Dino and [many contributors](https://github.com/welaika/wordmove/graphs/contributors). The workflow, the movefile format and most of the code are theirs. [kokiddp](https://github.com/kokiddp/wordmove) kept it running on modern Ruby, OpenSSL 3 and MariaDB. wordmove-ng is maintained by [tekgnosis.net](https://github.com/tekgnosis-net) under the MIT licence.

data/docs/installation.md

@@ -0,0 +1,104 @@
+---
+title: Installation
+nav_order: 2
+---
+
+# Installation
+{: .no_toc }
+
+1. TOC
+{:toc}
+
+## Ruby
+
+wordmove-ng needs **Ruby 3.0 or newer**. Check with `ruby --version`. If your system Ruby is older or missing, use a version manager:
+
+- [rbenv](https://github.com/rbenv/rbenv#installation)
+- [RVM](https://rvm.io/)
+- [mise](https://mise.jdx.dev/) (`mise use -g ruby@3.4`)
+
+## The gem
+
+```bash
+gem install wordmove-ng
+wordmove-ng --version
+```
+
+To run the latest `master` instead of a release:
+
+```bash
+gem install specific_install
+gem specific_install https://github.com/tekgnosis-net/wordmove-ng.git
+```
+
+From a checkout, for development:
+
+```bash
+git clone https://github.com/tekgnosis-net/wordmove-ng.git
+cd wordmove-ng
+bundle install
+bin/wordmove-ng --help
+```
+
+The legacy `wordmove` 5.x gem can stay installed alongside: the executables have different names.
+
+## Peer dependencies
+
+wordmove-ng is orchestration glue around standard tools. `wordmove-ng doctor` reports exactly what is missing on which side, and every database operation re-checks before doing anything.
+
+### Locally
+
+| Program | Needed for |
+| --- | --- |
+| `ssh`, `scp`, `rsync` | every remote operation |
+| `sshpass` | only when `ssh.password` is set in the movefile |
+| `gzip` | database sync |
+| `mysqldump` or `mariadb-dump` | `push -d` (dumping the local database) |
+| `mysql` or `mariadb` | `pull -d` (importing into the local database) and `doctor` |
+| `wp` ([WP-CLI](https://wp-cli.org)) | `pull -d` (adapting the local database) |
+
+### On each remote
+
+In the `$PATH` of a **non interactive** login. Check with `ssh host 'echo $PATH'`.
+
+| Program | Needed for |
+| --- | --- |
+| `rsync`, `gzip` | file and database sync |
+| `mysqldump` or `mariadb-dump` | `pull -d` |
+| `mysql` or `mariadb`, `wp` | `push -d` |
+
+WP-CLI is a single PHAR file. If your host does not ship it, put it in `~/bin` and add that directory to `PATH` in `~/.bashrc` or `~/.profile`: [installing WP-CLI](https://wp-cli.org/#installing).
+
+## Platform notes
+
+### macOS
+
+Install [Homebrew](https://brew.sh), then `brew install rsync`. Local database tools come with your MySQL/MariaDB or with tools such as MAMP or Local; make sure their `bin` directory is in your `PATH` (see [Troubleshooting]({{ site.baseurl }}/troubleshooting/#mysqldump-command-not-found-locally)). `sshpass` is only needed for password authentication (`brew install hudochenkov/sshpass/sshpass`); prefer keys.
+
+### Linux
+
+Everything comes from your distribution: for Debian and Ubuntu `sudo apt install rsync gzip openssh-client mariadb-client`, then WP-CLI as above.
+
+### Windows
+
+Use WSL (Windows Subsystem for Linux) and run wordmove-ng inside the Linux distribution. Native Windows is not supported.
+
+```powershell
+wsl --install
+```
+
+Then, inside the Ubuntu shell:
+
+```bash
+sudo apt update
+sudo apt install -y ruby-full build-essential rsync gzip openssh-client mariadb-client
+sudo gem install wordmove-ng
+ssh-keygen -t ed25519
+```
+
+Add `~/.ssh/id_ed25519.pub` to your host. In `movefile.yml` use Linux paths (`C:\` becomes `/mnt/c/`) and `127.0.0.1` rather than `localhost` for a MySQL server running on Windows. Files under `/mnt/c` all appear with permissions `777`; to get sane permissions on the server add
+
+```yaml
+ssh:
+  rsync_options: "--chmod=Du=rwx,Dgo=rx,Fu=rw,Fgo=r"
+```

data/docs/quick-start.md

@@ -0,0 +1,81 @@
+---
+title: Quick start
+nav_order: 3
+---
+
+# Quick start
+{: .no_toc }
+
+1. TOC
+{:toc}
+
+## 1. Create the movefile
+
+Run `init` from the directory that contains `wp-config.php`:
+
+```bash
+cd /path/to/your/wordpress
+wordmove-ng init
+```
+
+It writes `movefile.yml`, pre-filled with the local database credentials, socket or port from `wp-config.php` and the local URL from `WP_HOME`/`WP_SITEURL` or `wp option get home`. Open the file and fill in the `production` section (rename it as you like): the remote `vhost`, `wordpress_path`, database credentials **as seen from the remote host**, and the `ssh` block.
+
+```yaml
+production:
+  vhost: https://example.com
+  wordpress_path: /var/www/example
+  database:
+    name: example
+    user: example
+    password: "<%= ENV['PROD_DB_PASS'] %>"
+    host: localhost
+  ssh:
+    host: example.com
+    user: deploy
+```
+
+The full reference is in [Configuration]({{ site.baseurl }}/configuration/).
+
+## 2. Check everything
+
+```bash
+wordmove-ng doctor
+```
+
+The doctor validates the movefile, checks the local tools and database connection, then for each SSH remote tries a non interactive login and probes for `rsync`, `gzip`, `mysql`, `mysqldump` and `wp`. Fix what it reports before going on.
+
+## 3. Pull the site down
+
+```bash
+wordmove-ng pull -e production --all
+```
+
+Files are mirrored into your local install, the remote database is dumped, imported locally and rewritten to your local URL and path. Your previous local database is saved as `wp-content/local-backup-<timestamp>.sql.gz` first.
+
+## 4. Push changes up
+
+Simulate first: `-s` runs rsync with `--dry-run` and skips the database steps after logging what would happen.
+
+```bash
+wordmove-ng push -e production -t -p -s     # themes and plugins, dry run
+wordmove-ng push -e production -t -p        # for real
+wordmove-ng push -e production -d           # database only
+```
+
+A push of the database backs up the remote database to `wp-content/production-backup-<timestamp>.sql.gz` locally, dumps your local database, imports it on the remote and runs `wp search-replace` there. Your local database is never modified.
+
+## Everyday commands
+
+| Command | Effect |
+| --- | --- |
+| `wordmove-ng pull -e staging -u` | fetch the uploads folder from staging |
+| `wordmove-ng push -e production --all --no-db` | mirror every folder, keep the production database |
+| `wordmove-ng push -e production --all --no-uploads` | everything but uploads |
+| `wordmove-ng pull -e production -d --no-adapt` | import the production database without rewriting URLs |
+| `wordmove-ng list` | show every environment and its vhost |
+| `wordmove-ng help push` | all flags |
+
+With a single remote environment `-e` can be omitted. Every flag is explained in [Usage and flags]({{ site.baseurl }}/usage/).
+
+{: .warning }
+File sync **mirrors** the source: files missing at the source are deleted at the destination. Anything you need to keep on one side only goes in `exclude`.

data/docs/troubleshooting.md

@@ -0,0 +1,141 @@
+---
+title: Troubleshooting
+nav_order: 11
+---
+
+# Troubleshooting and FAQ
+{: .no_toc }
+
+Start with `wordmove-ng doctor`: it reproduces most problems below and names the failing command.
+
+1. TOC
+{:toc}
+
+## SSH
+
+### Non interactive SSH authentication failed
+{: .no_toc }
+
+wordmove-ng runs `ssh` with `BatchMode=yes` when no `ssh.password` is configured, so it never prompts. The doctor prints the exact command, for example `ssh -o BatchMode=yes -p 22 deploy@example.com true`; run it yourself to see what OpenSSH says. Usual causes: the key is not loaded in the agent (`ssh-add -l`), the host expects a different user, or the key is not in the remote `authorized_keys`. Anything you fix in `~/.ssh/config` applies to wordmove-ng automatically.
+
+### It worked with wordmove 5.x and rsync still works, but the database step asked for a password
+{: .no_toc }
+
+That was the old Net::SSH library, which could not sign RSA keys with SHA-2 and silently fell back to a prompt on modern servers. wordmove-ng no longer contains it. See [Upgrading]({{ site.baseurl }}/upgrading/#7-ssh-behaves-like-rsync-did).
+
+### Gateway / jump host
+{: .no_toc }
+
+`ssh.gateway` is passed as `ssh -J`; the bastion must accept your key or agent. `gateway.password` cannot be used. Alternatively configure `ProxyJump` in `~/.ssh/config` and only set `ssh.host`.
+
+### Password authentication
+{: .no_toc }
+
+`ssh.password` requires `sshpass` installed locally and exposes the password in the process list. Keys are strongly recommended.
+
+## Missing programs
+
+### `Missing programs required for the database sync (on "production": wp)`
+{: .no_toc }
+
+The remote needs `wp` (for push) in the `$PATH` of a **non interactive** login, which usually only reads `~/.bashrc` or `~/.profile`. Check with `ssh host 'command -v wp'`. Install WP-CLI as a PHAR in `~/bin` and add it to `PATH` in one of those files. The same applies to `gzip`, `mysql`/`mariadb` and `mysqldump`/`mariadb-dump`.
+
+### `mysqldump: command not found` locally
+{: .no_toc }
+
+Bundled stacks such as MAMP, XAMPP or Local keep the MySQL binaries out of your `PATH`. Find them (`sudo find /Applications -type f -name mysqldump` on macOS) and add the directory to your shell profile:
+
+```bash
+echo 'export PATH="/Applications/MAMP/Library/bin:$PATH"' >> ~/.zshrc
+```
+
+Reopen the terminal; `wordmove-ng doctor` should now find them.
+
+## Database
+
+### Import fails with a collation or charset error
+{: .no_toc }
+
+Newer `utf8mb3` collations are rewritten automatically before import. If your dump uses another collation the target does not know, add it to `global.collation_fallbacks`; see [Database sync]({{ site.baseurl }}/database-sync/#mariadb-and-mysql-compatibility).
+
+### `invalid byte sequence in UTF-8`
+{: .no_toc }
+
+wordmove-ng no longer rewrites dumps as text for URL adaptation, so this error from older versions should not occur. Binary or `latin1` data can still upset a transfer between servers with different defaults: add `--hex-blob` to `mysqldump_options` (thanks @360Zen), make sure your columns are `utf8mb4`, and use a UTF-8 locale in your shell (`export LC_ALL=en_US.UTF-8`). Tables of third party plugins can be skipped with `--ignore-table=db.table`.
+
+### `wordmove-ng init` fails with `invalid byte sequence in UTF-8`
+{: .no_toc }
+
+Some localized WordPress packages ship a `wp-config-sample.php` encoded in `iso-8859-1`, and people copy it to `wp-config.php`. Convert the file:
+
+```bash
+iconv -f ISO-8859-1 -t UTF-8 wp-config.php > wp-config.utf8.php && mv wp-config.utf8.php wp-config.php
+```
+
+### The remote site shows my local URLs after a push
+{: .no_toc }
+
+The import succeeded but `wp search-replace` on the remote failed; the log names the backup file. Run the search-replace by hand or restore, see [Backups and recovery]({{ site.baseurl }}/database-sync/#backups-and-recovery). Enable `global.maintenance_mode` to hide this window from visitors.
+
+### Different table prefixes
+{: .no_toc }
+
+Not supported: local and remote must use the same `$table_prefix`.
+
+### Large databases time out
+{: .no_toc }
+
+Raise `max_allowed_packet` and use `--single-transaction --quick` through `mysqldump_options` and `mysql_options`; see [Large databases]({{ site.baseurl }}/database-sync/#large-databases).
+
+## Files
+
+### Files I need were deleted
+{: .no_toc }
+
+Sync mirrors the source. Anything that must survive on one side only (uploads created on production, `.env`, caches) belongs in `exclude`. Backups of the database are never deleted by a sync, but add `wp-content/*.sql.gz` to `exclude` so they are not copied either.
+
+### Permissions are wrong on the server
+{: .no_toc }
+
+Use `rsync_options: "--chmod=Du=rwx,Dgo=rx,Fu=rw,Fgo=r"` (or a post-push hook with `find … -exec chmod`) and consider `--no-perms` from a CI runner; see [Usage]({{ site.baseurl }}/usage/#rsync-options-in-a-continuous-delivery-context).
+
+### Security plugins
+{: .no_toc }
+
+Plugins such as Wordfence write `.user.ini` and firewall files into the WordPress root that are specific to one host. Exclude them, or deactivate the plugin locally with a pull hook.
+
+## Movefile
+
+### `This remote is configured with ftp`
+{: .no_toc }
+
+FTP was removed in 6.0. Move the host to SSH or keep the legacy `wordmove` 5.x gem for it.
+
+### `global.sql_adapter … is ignored`
+{: .no_toc }
+
+Harmless leftover from 5.x; delete the key.
+
+### `"…" is a prefix of "…"`
+{: .no_toc }
+
+Two of the four search terms overlap; use distinct vhosts and paths, see [Prefix collisions]({{ site.baseurl }}/database-sync/#prefix-collisions).
+
+### YAML errors
+{: .no_toc }
+
+Indentation is the structure: two spaces, no tabs. Quote values containing `:` or `#`. The doctor prints the path of the offending key.
+
+## FAQ
+
+**Which transport is used?** SSH only: `rsync -e ssh` for directories, `ssh` for commands and hooks, `scp` for dump files. There is no Ruby-side SSH implementation.
+
+**Is the source database ever modified?** No. It is dumped; the import and the URL rewriting happen on the target.
+
+**Is there a rollback?** Backups of the target database are written to the local `wp-content` before every import; restore them by hand.
+
+**Is it transactional?** No. Prerequisites are checked before anything happens, and each step is logged, but an interruption in the middle can leave a `dump.sql` or `dump.sql.gz` in a `wp-content` folder, or the target with the source's URLs. Re-run the command or restore the backup.
+
+**What is left on my server?** Nothing but the site itself. Temporary dumps are removed after each run.
+
+**Windows?** Through WSL only; see [Installation]({{ site.baseurl }}/installation/#windows).

data/docs/upgrading.md

@@ -0,0 +1,61 @@
+---
+title: Upgrading from 5.x
+nav_order: 4
+---
+
+# Upgrading from wordmove 5.x
+{: .no_toc }
+
+This applies to both the original `wordmove` gem by weLaika and the kokiddp fork. Your `movefile.yml` keeps working with the exceptions below.
+
+1. TOC
+{:toc}
+
+## 1. Install the new gem, use the new command
+
+```bash
+gem install wordmove-ng
+```
+
+Call `wordmove-ng` instead of `wordmove`. Both gems can stay installed side by side; the executable was renamed on purpose, because both tools read the same `movefile.yml` while their push semantics differ.
+
+## 2. Ruby 3.0 or newer
+
+Ruby 2.6 and 2.7 are no longer supported. See [Installation]({{ site.baseurl }}/installation/#ruby).
+
+## 3. Put `wp` on your remotes
+
+`push -d` now adapts the database **on the remote**, so WP-CLI must be installed there and be in the `$PATH` of a non interactive login. It is a single PHAR file ([installing WP-CLI](https://wp-cli.org/#installing)). Run `wordmove-ng doctor` to confirm; a push refuses to start until it is found.
+
+## 4. FTP and SFTP are gone
+
+A movefile with an `ftp` block fails with a clear error. FTP only ever existed for shell-less shared hosts, where the database had to be handled by uploading temporary PHP scripts and URLs were rewritten in the dump with a regex. Keep the legacy `wordmove` 5.x gem for such hosts, or move them to SSH.
+
+## 5. `global.sql_adapter` is ignored
+
+URL and path adaptation always uses `wp search-replace` on the target; the regex-based `default` adapter no longer exists. The key is still accepted, with a warning, so old movefiles validate. Remove it when convenient. `database.charset`, removed in 3.0, is no longer accepted by the schema either. The `global` section is now optional.
+
+## 6. Push no longer touches your local database
+
+Old versions ran `wp search-replace` on the live local database during a push and restored it afterwards, which left the local site pointing at production if anything failed in between. That is gone: the local database is dumped, and the dump is adapted after import on the remote.
+
+## 7. SSH behaves like rsync did
+
+If rsync worked but the database step asked for a password, the cause was the old Net::SSH library, which could not sign RSA keys with SHA-2 and silently fell back to a prompt. That code path no longer exists: everything uses the system `ssh` client. If key authentication fails now, you get an error naming the failed command instead of a prompt. `ssh.gateway` is passed as `ssh -J`; `ssh.gateway.password` cannot be honoured and is ignored.
+
+## 8. Remote programs are checked up front
+
+Missing `gzip`, `mysql`, `mysqldump` or `wp` on either side aborts before any backup or dump, listing what is missing.
+
+## 9. New, optional: maintenance mode
+
+`global.maintenance_mode: true` wraps the target's import and search-replace in `wp maintenance-mode activate` / `deactivate`. See [Database sync]({{ site.baseurl }}/database-sync/#maintenance-mode).
+
+## Checklist
+
+```bash
+gem install wordmove-ng
+sed -i '/sql_adapter/d' movefile.yml     # optional tidy-up
+wordmove-ng doctor                        # fix anything it reports
+wordmove-ng push -e production -d -s      # dry run
+```

data/docs/usage.md

@@ -0,0 +1,129 @@
+---
+title: Usage and flags
+nav_order: 6
+---
+
+# Usage and flags
+{: .no_toc }
+
+1. TOC
+{:toc}
+
+## Commands
+
+```
+wordmove-ng --version, -v   # Print the version
+wordmove-ng doctor          # Do some local configuration and environment checks
+wordmove-ng help [COMMAND]  # Describe available commands or one specific command
+wordmove-ng init            # Generates a brand new movefile.yml
+wordmove-ng list            # List all environments and vhosts
+wordmove-ng pull            # Pulls WP data from remote host to the local machine
+wordmove-ng push            # Pushes WP data from local machine to remote host
+```
+
+### `init`
+{: .no_toc }
+
+Writes `movefile.yml` in the current directory, reading `wp-config.php` for the local database credentials (splitting `DB_HOST` values that carry a port or a socket) and the local URL from `WP_HOME`, `WP_SITEURL` or `wp option get home`.
+
+### `doctor`
+{: .no_toc }
+
+Checks, in order: movefile schema (rejecting `ftp` blocks and reporting prefix collisions), local `mysql`/`mysqldump` and a connection with the local credentials, local `wp` presence and freshness, `rsync`, `ssh`, then for each SSH remote a non interactive login followed by a probe for `rsync`, `gzip`, `mysql`/`mariadb`, `mysqldump`/`mariadb-dump` and `wp`. It also warns about `ssh.gateway.password`. Run it before opening an issue and paste the output.
+
+### `list`
+{: .no_toc }
+
+Prints every environment with its `vhost`.
+
+### `push` and `pull`
+{: .no_toc }
+
+```
+Options:
+  -w, [--wordpress], [--no-wordpress]
+  -u, [--uploads], [--no-uploads]
+  -t, [--themes], [--no-themes]
+  -p, [--plugins], [--no-plugins]
+  -m, [--mu-plugins], [--no-mu-plugins]
+  -l, [--languages], [--no-languages]
+  -d, [--db], [--no-db]
+  -v, [--verbose], [--no-verbose]
+  -s, [--simulate], [--no-simulate]
+  -e, [--environment=ENVIRONMENT]
+  -c, [--config=CONFIG]
+      [--debug], [--no-debug]
+      [--no-adapt], [--no-no-adapt]
+      [--all], [--no-all]
+```
+
+`pull` copies from the remote given with `-e` to `local`; `push` copies from `local` to that remote. At least one component flag (or `--all`) is required.
+
+## Flags
+
+| Flag | Meaning |
+| --- | --- |
+| `-w`, `--wordpress` | the WordPress core, ignoring `wp-content` |
+| `-u`, `--uploads` | `wp-content/uploads` |
+| `-t`, `--themes` | `wp-content/themes` |
+| `-p`, `--plugins` | `wp-content/plugins` |
+| `-m`, `--mu-plugins` | `wp-content/mu-plugins` |
+| `-l`, `--languages` | `wp-content/languages` |
+| `-d`, `--db` | the database; see [Database sync]({{ site.baseurl }}/database-sync/) |
+| `--all` | every component; combine with `--no-*` to leave some out |
+| `--no-<component>` | exclude one component, usually with `--all` |
+| `-s`, `--simulate` | rsync runs with `--dry-run`; database steps are logged and skipped |
+| `-e ENV`, `--environment` | which remote to use; optional with a single remote |
+| `-c FILE`, `--config` | alternate movefile inside the project |
+| `--no-adapt` | import the database without running `wp search-replace` |
+| `-v`, `--verbose` | more output |
+| `--debug` | accepted for compatibility; had an effect only with the removed FTP deployer |
+
+Component paths respect the `paths` section of each environment.
+
+## Examples
+
+```bash
+wordmove-ng pull -e staging --all              # everything from staging
+wordmove-ng push -e production --all --no-db   # every folder, keep the production database
+wordmove-ng push -e production --all --no-db --no-uploads
+wordmove-ng push -e production -t -p -s        # dry run of themes and plugins
+wordmove-ng pull -e production -d --no-adapt   # database without URL rewriting
+wordmove-ng push -c movefile.client.yml -e live -u
+WORDMOVE_MAINTENANCE_MODE=1 wordmove-ng push -e production -d
+```
+
+## Mirroring
+
+File sync mirrors the source: files missing at the source are **deleted** at the destination. Use `exclude` for anything that must survive on one side only (uploads produced on production, `.env` files, caches).
+
+## Work only on specific plugins or themes
+
+`-p` considers the whole `plugins` folder. rsync patterns starting with `+ ` are inclusions, so you can exclude everything but one plugin:
+
+```yaml
+exclude:
+  - "+ wp-content/plugins/plugin_1/"
+  - "wp-content/plugins/*"
+```
+
+The same works for themes and any other folder.
+
+## Running unattended
+
+wordmove-ng never prompts, so it can run from cron, systemd timers or CI. The environment those give you is the only difference; see [Automation and cron]({{ site.baseurl }}/automation/) for a ready-made script and the SSH key setup.
+
+## Rsync options in a continuous delivery context
+
+The default rsync flags are `-rlpt`. On a CI runner every file is freshly checked out, so `--times` triggers a full transfer every time and `--perms` may not be what you want:
+
+```yaml
+ssh:
+  rsync_options: "--itemize-changes --chmod=D775,F664 --no-perms --no-times --checksum"
+```
+
+`--no-perms` and `--no-times` disable the defaults, `--checksum` compares content instead of timestamps (slower, but transfers only real changes), and `--chmod` gives you control over what lands on the server.
+
+## Logging
+
+Long generated shell scripts are summarised into intent lines such as `dump database my_db to ./wp-content/dump.sql`, `compress ./wp-content/dump.sql`, `wp search-replace old.test -> new.test in /var/www/site` and `import SQL dump … (strip sandbox header, append COMMIT)`. Passwords, hosts, vhosts and paths from the movefile are masked as `[secret]` in all output, including hook output.

data/lib/wordmove/version.rb

@@ -1,3 +1,3 @@
 module Wordmove
-  VERSION = "6.0.0".freeze
+  VERSION = "6.0.2".freeze
 end

data/wordmove-ng.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
     "source_code_uri" => spec.homepage,
     "changelog_uri" => "#{spec.homepage}/blob/master/CHANGELOG.md",
     "bug_tracker_uri" => "#{spec.homepage}/issues",
-    "documentation_uri" => "#{spec.homepage}/wiki",
+    "documentation_uri" => "https://tekgnosis-net.github.io/wordmove-ng/",
     "rubygems_mfa_required" => "true"
   }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wordmove-ng
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.0.2
 platform: ruby
 authors:
 - Kumar
@@ -214,6 +214,7 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/config.yml"
 - ".github/stale.yml"
+- ".github/workflows/pages.yml"
 - ".github/workflows/release.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -250,7 +251,24 @@ files:
 - bin/setup
 - bin/thor
 - bin/wordmove-ng
+- contrib/wordmove-sync.sh
 - deploy/deploy.sh
+- docs/Gemfile
+- docs/README.md
+- docs/_config.yml
+- docs/assets/images/wordmove-ng.png
+- docs/automation.md
+- docs/configuration.md
+- docs/contributing.md
+- docs/database-sync.md
+- docs/environments.md
+- docs/hooks.md
+- docs/index.md
+- docs/installation.md
+- docs/quick-start.md
+- docs/troubleshooting.md
+- docs/upgrading.md
+- docs/usage.md
 - exe/wordmove-ng
 - lib/wordmove-ng.rb
 - lib/wordmove.rb
@@ -291,7 +309,7 @@ metadata:
   source_code_uri: https://github.com/tekgnosis-net/wordmove-ng
   changelog_uri: https://github.com/tekgnosis-net/wordmove-ng/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/tekgnosis-net/wordmove-ng/issues
-  documentation_uri: https://github.com/tekgnosis-net/wordmove-ng/wiki
+  documentation_uri: https://tekgnosis-net.github.io/wordmove-ng/
   rubygems_mfa_required: 'true'
 post_install_message: |2
       wordmove-ng 6.0 is a breaking release compared to wordmove 5.x: