De opdrachten in één oogopslag – cloneworx Hulp

Doelen, back-upplannen, back-ups, herstel en instellingen van cloneworx Backup bedien je ook op de opdrachtregel, zonder browser. Hier staan alle commando’s van de plugin met hun acties en de regels die voor elk commando gelden.

Is WP-CLI op jouw server nog niet ingesteld? Begin dan met WP-CLI installeren.

Zo is een commando opgebouwd

Elk commando begint met “wp cloneworx-backup”. Daarna volgen het commando, de actie, zo nodig een naam en de parameters. Een parameter begint met twee koppeltekens.

# Commando target, actie test, doel local-1
wp cloneworx-backup target test local-1

# Commando plan, actie run, plan plan-1, parameter --background
wp cloneworx-backup plan run plan-1 --background

Je voert de commando’s uit in de map van je website, dus daar waar WordPress staat.
Laat je de actie weg, dan geldt de standaard van het commando. wp cloneworx-backup target is hetzelfde als wp cloneworx-backup target list.
De uitvoer is Engels en wordt niet vertaald.
De hulp van WP-CLI noemt bij elk commando de acties en parameters, bijvoorbeeld wp help cloneworx-backup target.

Alle commando’s

De vetgedrukte actie is de standaard en geldt als je geen actie noemt.

Commando	Acties	Waarvoor	Meer daarover
`target`	list, add, edit, remove, test, check, cleanup, moved, copy, sites, adopt, rebuild	Doelen tonen, aanmaken, wijzigen, verwijderen en testen. De back-ups op een doel controleren, resten opruimen, een vingerafdrukconflict beantwoorden, back-ups terugvinden na een totaal verlies.	Doelen beheren met WP-CLI
`plan`	list, add, edit, pause, resume, remove, run	Back-upplannen tonen, aanmaken, wijzigen, pauzeren, inschakelen, verwijderen en meteen uitvoeren.	Back-upplannen beheren met WP-CLI
`backup`	run, list, lock, unlock, check, download, delete	Een back-up zonder plan maken. Back-ups tonen, vergrendelen, controleren, als bestand schrijven en verwijderen.	Back-ups maken en beheren met WP-CLI
`retention`	list, run	Tonen welke oude back-ups volgens Max. back-ups zouden wegvallen, of ze nu verwijderen.	Back-ups maken en beheren met WP-CLI
`restore`	precheck, run, status, keep, undo	De voorcontrole uitvoeren, een herstel starten, de toestand ervan tonen, het behouden of ongedaan maken.	Herstellen en importeren met WP-CLI
`import`	geen; het commando neemt het pad van een bestand en de parameter `--target`	Een back-upbestand opslaan op een doel van deze website en opnemen in de lijst met back-ups.	Herstellen en importeren met WP-CLI
`scheduler`	status, tick	Het schema tonen. Met tick controleren of een plan aan de beurt is, en het starten: dat is de regel voor de systeemcron.	Planning en systeem-cron met WP-CLI
`settings`	list, get, set, reset	De instellingen van de website tonen, lezen, zetten en terugzetten op de standaardwaarden.	Instellingen en omvang met WP-CLI
`scope`	roots, tables, exclusions, all	Tonen wat bij de website hoort. De uitsluitingsregels zetten en de tabellen waarvan alleen de structuur wordt bewaard.	Instellingen en omvang met WP-CLI
`status`	geen	De toestand van de website tonen: hetzelfde resultaat als de statustegel van de pagina Overzicht.	Status, logboeken en support met WP-CLI
`logs`	geen	De logbestanden weergeven of alle in een tar-bestand schrijven.	Status, logboeken en support met WP-CLI
`support`	geen	Het supportrapport uitvoeren of in een bestand schrijven.	Status, logboeken en support met WP-CLI
`debug`	on, off, status	De foutopsporing in het logboek in- en uitschakelen. Na 24 uur schakelt die zichzelf uit.	Status, logboeken en support met WP-CLI
`notify`	status, check, test	De toestand van de meldingen tonen, nu controleren op achterstallige back-ups, een testmail verzenden.	Status, logboeken en support met WP-CLI
`news`	status, subscribe, unsubscribe	De aanmelding voor nieuws over cloneworx Backup tonen, beginnen of beëindigen.	Status, logboeken en support met WP-CLI
`job`	run, status, abort, probe, filelist, dbexport, files	De lopende taak tot het einde uitvoeren, de toestand ervan tonen of hem afbreken. De proefrun en de diagnosetaken starten.	Status, logboeken en support met WP-CLI

Doel, plan en back-up noemen

Wat	Zo noem je het	Waar je het vindt
Doel	Achter de actie met zijn kenmerk (`local-1`, `sftp-1`) of zijn naam. In de parameters `--targets` en `--target` staat het kenmerk.	`wp cloneworx-backup target list`
Plan	Achter de actie met zijn kenmerk (`plan-1`) of zijn naam. In de parameter `--plan` staat het kenmerk.	`wp cloneworx-backup plan list`
Back-up	Met zijn taaknaam: datum, tijd en een kenmerk van 32 tekens.	`wp cloneworx-backup backup list`

Bij de naam van een doel speelt hoofdlettergebruik geen rol. Bij de naam van een plan geldt dat voor de letters a tot z; umlauten en accenten schrijf je zoals ze in de naam staan. Een naam met spaties zet je tussen aanhalingstekens: wp cloneworx-backup plan run "Dagelijkse back-up".

Als welke gebruiker je werkt

WP-CLI draait vaak als een andere gebruiker dan de website. Bestanden en mappen die een commando dan aanmaakt, zou de website later niet meer kunnen wijzigen of verwijderen. Bijna elk commando dat iets wijzigt of een taak start, controleert daarom eerst of je werkt als de gebruiker aan wie de mappen van de plugin toebehoren. Zo niet, dan breekt het af en noemt het beide gebruikers. In het voorbeeld hieronder zijn web en vuser de gebruiker en de groep van de website; vul die van jouw website in.

# Als gebruiker van de website uitvoeren (voorbeeld: web en vuser)
sudo -u web -g vuser -H wp cloneworx-backup backup run

De acties list en status controleren de gebruiker niet: lijsten en toestanden toon je onder elke gebruiker. settings controleert hem ook bij het zetten niet, want het commando schrijft alleen in de database.
Zonder controle lopen ook backup lock, backup unlock, backup download, job run, job abort, logs en support.
Met --force loopt een commando toch en waarschuwt het alleen. Het risico blijft: wat het aanmaakt, behoort aan de verkeerde gebruiker toe.
restore run, restore keep en restore undo kennen geen --force. Een herstel schrijft in de website zelf.

In dit proces of op de achtergrond

Back-up, controle, opruimen, herstel en import lopen als taak in veel korte stappen. Zonder verdere parameter voert het commando de taak zelf tot het einde uit. Het toont per stap een regel met de voortgang en aan het einde het resultaat. De pauze tussen de stappen uit de instellingen laat het weg.

Een uitzondering vormt het herstel: het omschakelen naar de herstelde toestand draagt het commando over aan de webserver en wacht tot dat klaar is. Meer daarover: Herstellen en importeren met WP-CLI.

Met --background start het commando de taak alleen. De website voert hem dan zelf verder uit: via de zelfaanroep van de server, met WP-Cron als vangnet daaronder. De stand toont wp cloneworx-backup job status.

Commando	Acties met `--background`
`target`	check, cleanup, adopt, rebuild
`plan`	run
`backup`	run, check
`restore`	run, keep, undo
`import`	het commando zelf
`scheduler`	tick
`job`	probe, filelist, dbexport, files

Eén taak per website

Er loopt altijd maar één taak tegelijk. Loopt er al een, dan weigert het commando de start en noemt het de lopende taak: Another job is active: …. One job per site.

Wachtwoorden en sleutels

Wachtwoorden en sleutels accepteert de opdrachtregel nooit. Elke waarde zou daar in de lijst met processen en in de geschiedenis van de shell staan. Doelen met inloggegevens stel je daarom in op de pagina Doelen. Testen, controleren en in een plan gebruiken kun je ze daarna ook op de opdrachtregel.

De parameter --path

--path is een parameter van WP-CLI, niet van de plugin: hij noemt het pad naar WordPress als je niet in de map van de website bent. De map van een lokaal doel zet je met --set-path.

# Het pad naar WordPress: een optie van WP-CLI
wp cloneworx-backup status --path=/pfad/zur/website

# De map van een lokaal doel: een instelling van het doel
wp cloneworx-backup target add local --set-path=/var/backups

Hetzelfde pad als de webserver

Roep WP-CLI aan via het pad waarlangs ook de webserver de website bereikt. De vingerafdruk van de installatie bevat het pad op de server. Via een ander pad, bijvoorbeeld een symlink, ziet dezelfde installatie eruit als een kopie: de plugin noteert een vingerafdrukconflict en schrijft en verwijdert op dit doel niets.

Zie ook