Remote
Free & PremiumThe Remote tool window (⌘2) connects the editor to your servers over SSH and SFTP. You see a server's files like a second project tree, open and edit them, upload and download, open a terminal on the server and sync local folders with server folders. The editor shares its connections with WebDonkey: what you add here shows up there, and the other way round.
What you do here
- Connections: add servers, log in, sort them into projects, mark production
- Files on the server: the server's tree, open, edit, upload, create and delete files
- Server software: the server's PHP, Node.js, web server and databases with their version status
- Transfers: uploads and downloads in the background
- Mappings and sync: pair local folders with server folders and sync them
- Server tools: terminal, git and Claude on the server
- Fetch locally: copy a website from the server to the Mac as a local site
- Backups, cron jobs and logs: WebDonkey's pages for remote backups, scheduled tasks and server logs as tabs
Page layout
- Connections: the list of your servers, grouped by project, with a search field and buttons in the header bar.
- Open server: header bar with name and buttons, the Server software line, the current folder and the server's tree. All connections leads back to the list.
- Transfers: at the bottom of the window, running and finished transfers.
A caution notice sits at the top: Remote works directly on the server, often with sensitive data. Check the target and the connection before you overwrite or delete anything, and keep current backups at hand. You switch the notice off under Settings › Remote › Remote notices.
Free and Premium
SSH, SFTP, mappings and sync, server software as well as remote backups, scheduled tasks and server logs are part of WebDonkey Premium. Without Premium the Remote window shows a notice. The editor gets Premium through WebDonkey or through a license key of its own in the settings (see About).
Fetch locally is free: you open it without Premium too, from the command palette (⌘K) with Remote: fetch locally. It needs WebDonkey on this Mac.
Connections Premium
A connection tells the editor how to reach a server over SSH: host, port, user and login. The Connections list in the Remote window shows all servers, sorted into projects. WebDonkey knows the same connections, so changes here apply there too.
Where to find it
Open the Remote window (⌘2). Without an open server you see the Connections list. From an open server you get back with All connections (arrow on the left of the header bar).
How to do it
Add a new connection
- Click + (New connection) in the header bar. To put the connection straight into a project, hover over the project's row and click its +: that project is then preselected.
- If the server is already in
~/.ssh/config, pick it under Import from ~/.ssh/config. The editor takes over host, port, user and key or agent. - Fill in the fields (see below). Name, Host and User are required, with Key file the key too.
- Click Save & connect. The editor saves, connects and shows the server's tree. Save only creates the connection.
Connect and disconnect
- Double-click a connection to connect and open its tree. The Connect button that appears when you hover over the row does the same.
- Disconnect in the context menu, or the plug button in the header bar of an open server, closes the connection.
- If a connection drops, the open server shows the line Disconnected with the reason. A click on it reconnects.
Edit
Hover and click the pencil (Edit connection), choose Edit in the context menu, or click the name in the header bar of an open server. The dialog has two tabs: Connection and Mappings (see Mappings and sync). When you edit, the stored password (or passphrase) is already in the field, the eye shows it. Empty the field and save, and the stored password is deleted. If you switch to another app for a moment, your input in the dialog stays.
Fields and options
| Field | Meaning |
|---|---|
| Import from ~/.ssh/config | new connections only, and only if there are hosts: Choose a host … fills the fields from your SSH configuration |
| Name | what the connection is called in lists, tabs and terminals |
| Host | name or IP address of the server |
| Port | 22 by default |
| User | the SSH user |
| Authentication | Password, Key file or SSH agent (1Password, Secretive …) |
| Key file | with Key file: the list Choose a key from ~/.ssh … or Browse for a file elsewhere. The editor reads the list of keys again each time before it opens, so a key just created in WebDonkey is there right away. |
| Key passphrase (optional) | with Key file, if the key has one |
| Password | with Password |
| Agent socket (optional, else SSH_AUTH_SOCK) | with SSH agent: your agent's socket, for example 1Password's. Empty means SSH_AUTH_SOCK. No password is stored then. |
| Homepage (optional) | the web address of the website on the server. Without https:// the editor adds it. In the list and in the header bar the globe opens this address in the browser. |
| Project | assigns the connection to a project of the list. No project is the default, New project … creates one right there. |
| Start folder (optional) | the folder the server's tree starts in, for example /var/www. Browse saves the connection, connects and shows the server's folders; Use this folder takes the one shown. Empty, the tree starts in the home folder. |
| Colour mark | None, Red (production), Orange, Yellow, Green, Blue, Purple, Grey. The dot appears before the name in the list. |
WebDonkey stores credentials encrypted on this Mac. Saving changes nothing on the server.
Production
Give a connection the colour mark Red and it counts as production. Its row carries the badge Production, and every tab and terminal of this server gets a red edge. The editor is more careful there:
- The question before deleting names the server with the addition PRODUCTION.
- The question when moving or copying by dragging on the server defaults to Cancel.
- Uploading through a mapping, and deleting and renaming with Transfer deleting and renaming right away, always show the preview first.
- Upload on save asks whether you really want to turn it on.
Sort and find
- New project (folder icon in the header bar) creates a group. Projects belong to WebDonkey; you see the same order there.
- Assign project ▸ in a connection's context menu moves it into a project, to No project or into a New project ….
- Right-click a project's row: Rename project and Remove project. Removing only drops the assignment; the connections stay.
- A click on a project's row expands or collapses it. The editor remembers which projects are collapsed per project window.
- Search connections looks at name, host, user, project and homepage. Every word has to match. Esc empties the field. If the search finds a connection through its homepage, the address shows in an extra line.
A connection's context menu
Connect, Terminal (a shell on the server, see SSH terminal), Edit, Mappings …, Assign project ▸, Disconnect (when connected) and Delete.
Delete asks “Delete connection …?”. The connection disappears from WebDonkey too; nothing on the server is touched. If WebDonkey still uses the connection for server backups or syncs, the editor refuses and says what for. Detach those in WebDonkey first.
Host key
If a server presents a different host key than last time, the editor asks The server's key has changed and shows the new fingerprint. After a reinstall of the server that is expected. Otherwise someone may sit between you and the server. Trust new key stores the new key and connects, Cancel does not connect.
Troubleshooting
| What you see | What to do |
|---|---|
| The server rejected the login. | check user, password or key |
| Could not reach the server. | check host and port, internet connection and firewall |
| No SSH agent reachable | start the agent (for example unlock 1Password) or check the Agent socket field |
| The SSH agent holds no keys. | load the key into the agent |
| The key file could not be read (wrong passphrase?). | check the passphrase |
| No password stored for this connection. | edit the connection and enter the password |
| The server allows no further session | close a terminal on this server and try again |
| Remote connections are part of Premium. | activate Premium, see Remote |
See also
Files on the server Premium
Once connected, the Remote window shows the server's file tree. It works like the project tree: expand folders, open files, rename, select several entries, drag. You edit a server file in a working copy and upload it only when you want to.
Where to find it
Open the Remote window (⌘2) and connect by double-clicking a connection, see Connections.
The header bar
| Button | Effect |
|---|---|
| All connections (arrow on the left) | back to the list of connections. The connection stays open. |
| Server name | a click opens Edit connection. For production the server icon is red. |
| Globe | opens the connection's homepage, if one is set |
| Parent folder | the tree starts one level higher |
| New file, New folder | adds a new row for the name in the selected folder |
| Upload files … | pick files in the Finder and upload them into the selected folder |
| Mappings … | opens this connection's mappings, see Mappings and sync |
| Open terminal here | a shell on the server in the selected folder |
| Refresh | reads every expanded folder again |
| Disconnect | closes the connection |
Below are the Server software line and the current folder (~ stands for the home folder on the server).
How to do it
Edit a file
- Click a file in the tree. It opens as a preview tab; a double-click opens it as a regular tab.
- Edit it like a local file. ⌘S saves into the editor's working copy, never straight onto the server.
- Above the file the bar Remote file shows server and path, for production the label Production, and whether the file is changed, not saved or saved locally, not uploaded yet.
- Click Upload. The editor first checks whether someone changed the file on the server in the meantime.
The bar also offers:
- Compare: server and local version side by side.
- Reload from server: fetches the server's version. Your local changes are lost, so the editor asks first.
If the file changed on the server since you opened it, the editor asks “…” was changed on the server: Compare, Upload anyway or Cancel. When you upload over an existing file, its owner, group and permissions on the server stay as they are.
If you close a file that is not uploaded yet, the editor asks: Keep locally, Upload, Discard or Cancel. Kept changes are back the next time you open the file, after a restart too.
Navigate
- A click on a folder expands or collapses it.
- Open in a folder's context menu makes it the start of the tree.
- The .. row at the top goes one level up.
- Symlinks carry a chain icon; the tooltip names the target. A broken link is grey with a red icon. A link that leads back to a folder above does not expand; a double-click opens it as the start of the tree.
The context menu
| Entry | Effect |
|---|---|
| Open | open a file, or a folder as the start of the tree |
| New ▸ | New file (⌘N), New folder |
| Rename (⇧F6), Duplicate (⌘D) | single entry only |
| Delete (⌘⌫) | see below |
| Permissions … | permissions as three or four octal digits, for example 644 or 755 |
| Download … | into a folder of your choice on the Mac |
| Download into project | into the folder of the open project |
| Upload files … | files from the Finder into this folder |
| Copy server path (⌥⌘C) | one path per line |
| Mapping entries | with Premium on mapped folders, see Mappings and sync |
| Find in folder … | searches in this folder on the server, see On a server |
| Open terminal here | shell on the server in this folder |
| Git ▸, Start Claude here | only where they fit, see Server tools |
Deleting
Delete asks first and names the server, with the addition PRODUCTION for production, and the paths. The question defaults to Cancel.
- There is no Trash on a server. Folders are deleted with all their contents in one step.
- Symlinks are deleted as links only; their target stays.
- The editor never deletes the home folder or
/. - Tabs of deleted files close.
Dragging on the server
- Within one server you drag entries onto a folder: that moves them, with ⌥ it copies. Both ask first and name server and target. For production the question defaults to Cancel.
- If the target already holds the same name, the editor asks: Skip or Keep both, for files also Replace. The editor never replaces a folder on the server, since it would be gone for good.
- There is deliberately no dragging between two servers. Download and upload to the other server instead.
- From the project tree onto a server folder: uploads. From the server tree into the project tree: downloads. Onto a terminal: inserts the paths.
Keyboard
↑ ↓ (with ⇧ to extend the selection), → expand, ← collapse or go to the parent folder, ↩ open, F2 or ⇧F6 rename, ⌘D duplicate, ⌘N new file, ⌘⌫ delete, ⌥⌘C copy server path. ⌘-click and ⇧-click select several entries.
Free and Premium
Files on the server are Premium, like everything in the Remote window.
Troubleshooting
| What you see | Why | What to do |
|---|---|---|
| The file name is not stored as UTF-8 on the server | The name cannot be addressed. | rename the file in the terminal |
| The file is too large. | too large to open in the editor | download it and open it locally |
| Permission denied | The connection's user may not do that. | check permissions, change them with Permissions … or connect as the user who owns the files |
| The folder cannot be read. | missing read permission or folder deleted | Refresh, check permissions |
| The server does not offer SFTP. | SFTP is turned off on the server. | ask your host to turn SFTP on |
See also
Server software Premium
Below the header bar of an open server, the Server software line shows what runs on the server: PHP, Node.js, web servers, databases and Redis, each with its version. A mark next to it says whether that version still gets updates, falls out of support soon or has a known vulnerability. So while you work on a server you see right away where an update is due.
Where to find it
In the Remote window (⌘2) open a server with a double-click. The line sits right under the header bar, above the current folder.
What the line shows
- Programs: PHP, Node.js, nginx, Apache, Caddy, MySQL, MariaDB, PostgreSQL, Redis and Valkey, as far as the server has them. Hover over a name to see the program's path. If only the command line tool of a database is there, not the server itself, (client) follows; the database then may run on another host. If the editor finds several versions of a program, such as several PHP versions of a host, each one is listed.
- checking … while the editor asks, and nothing known found when none of the programs is there.
- Check again (arrow on the right) asks the server again right away.
In a narrow window the marks shrink to coloured dots. The word and all details are then in the tooltip.
The marks
| Mark | Meaning |
|---|---|
| Supported | The release line gets updates. |
| Update available | There is a newer release in this line. The tooltip names it. |
| Security fixes only | The line only gets security fixes, no bug fixes. |
| Support ends soon | Support ends shortly; the tooltip gives the date. |
| Vulnerable | A newer release of this line fixes a known vulnerability. |
| EOL | No more updates, not even security fixes. |
A mark's tooltip names the release line, dates of the end of support, Long-term support (LTS) where it applies, a recommended line and when the data was fetched. For versions the editor cannot place, it shows no mark.
Settings
Settings › Remote › Fetch version status (on by default). When it is off, the editor asks no website for the version status, and there are no marks, neither here nor in Fetch locally. The versions themselves stay in the line. The editor takes its default from the setting of the same name in WebDonkey; your choice in the editor applies after that.
What happens in the background
- On the server the editor only reads the versions with
--versionover the connection that is already open, once you open the server. Nothing on the server changes. The result is kept for six hours; Check again fetches it anew right away. - On the internet the editor asks endoflife.date, php.net, nodejs.org and nginx.org whether a version still gets updates. Only product names go out (for PHP the major version), never names of sites or servers.
Free and Premium
The line is part of the Remote window and therefore Premium.
Troubleshooting
| What you see | Why | What to do |
|---|---|---|
| The line is missing | The connection is down, or the server did not answer. | reconnect |
| Versions without marks | Fetch version status is off, the Mac is offline, or the version is unknown. | check the setting, Check again later |
| A program is missing | It is neither in the SSH user's path nor in one of the usual places (such as Plesk, cPanel, nvm). | check in the SSH terminal, for example with which php |
See also
Transfers Premium
Uploads and downloads run in the background while you keep working. At the bottom of the Remote window the Transfers list shows what is running and what is done. At the end the editor briefly tells you whether everything arrived.
Where to find it
The list appears at the bottom of the Remote window as soon as there is a transfer. With an open server it shows that server's transfers only, in the connection list all of them. A click on Transfers collapses it; the number in brackets counts the running ones.
How to do it
Upload
- Upload files … in the header bar or in the server tree's context menu: pick files in the Finder; they land in the selected folder.
- Drag files or folders from the project tree onto a folder in the server tree.
- In the tab of an open server file, Upload in the bar, see Files on the server.
- Through a mapping: Upload to with the server's name in the project tree's context menu, see Mappings and sync.
- Upload to … (⌥⇧⌘X) always shows the list of targets first: server and path per mapping, for a server file also where it came from. ↑ ↓ choose, ↩ uploads, Esc cancels. It acts on the selection in the project tree, otherwise on the open file. Excluded targets are greyed out and name the pattern.
Download
- Download …: pick any target folder on the Mac.
- Download into project: into the folder of the open project.
- Drag entries from the server tree into the project tree: into the folder under the pointer.
- In the server tree, on mapped folders, Download to … (⌥⇧⌘X): into the mapped local folder.
If the target already holds the same name, the editor asks: Skip, Keep both or, for files, Replace. It never replaces a folder on the server.
The list
Each transfer shows direction (arrow up or down), name and state:
- while running, for example “3 / 10 files · 2.4 MB / 4.0 MB” and a progress bar. Hover over the name to see the file in progress.
- at the end Done with the size, Cancelled or Failed.
Controls:
- Cancel (X on the row) stops a running transfer.
- If a transfer had errors, the arrow in front expands the list of affected files with the reason.
- Clear finished removes every finished transfer from the list.
What happens in the background
- When downloading, the editor skips names that would land outside the target folder and says so.
- When syncing through a mapping, the editor replaces files atomically: a running website never sees a half-written file.
Troubleshooting
Error messages name the reason; common ones are:
| Reason | What to do |
|---|---|
| Permission denied | check the permissions at the target or connect as the user who owns the files |
| Not there on the server | read the tree again with Refresh |
| The disk on the server is full | free up space on the server |
| The connection to the server was cut | reconnect and repeat the transfer |
| The server does not answer | try again later, check the connection |
| The server refused without a reason | often the disk is full or the quota is used up |
| The server allows no further session on this connection | close a terminal on this server |
See also
Mappings and sync Premium
A mapping pairs a local folder (or a file) with a folder on a server, similar to the deployment in PhpStorm. Then you upload single files or whole folders with a right-click, download them or compare both sides. A connection can have several mappings, and one local folder may point to several servers, such as staging and live. Mappings are the same sync pairs as in WebDonkey.
Nothing is transferred on its own. By default every mapping is set to On command only: saving saves locally, and nothing is uploaded or downloaded until you trigger it. You switch automatic transfers on per mapping, on purpose.
Where to find it
- Tools ▸ Mappings & Sync…, the Mappings & Sync… button in the header bar of the connection list, or the command palette (⌘K): opens the Mappings & Sync view as a tab.
- In the Remote window: a connection's context menu ▸ Mappings …, or the Mappings … button of an open server: opens the connection's Mappings tab.
- Right-click in the project tree or in the server tree: the entries to transfer, see below.
How to do it
Create a mapping
- Right-click the local folder in the project tree ▸ Create mapping…. The Mappings & Sync view opens with the New sync pair dialog, the folder already filled in. Or right-click in the server tree ▸ Create mapping…: then the server folder and the project as local folder are filled in.
- The server is named under the dialog's title. If it is the wrong one, cancel, pick the right one at the top under Server and click New sync pair.
- Fill in Name, Local folder or file and Folder or file on the server. Browse… picks on the server, Folder… and File… on the Mac. A folder that does not exist on the server yet is created on the first upload.
- Optionally Exclude (one pattern per line): for example
.git,node_modules,var/cacheor*.log. These paths stay local. - Under In the WebDonkey Editor, switch on Upload on save and Transfer deleting and renaming in the editor right away if you want them.
- Click Save. The folder now has a tinted background in both trees; a small mark and the tooltip name server and target.
In the Mappings tab of the connection dialog the same works with Add mapping: Name, Local folder, Folder on … (both with a full path starting with /; Browse and Use this folder help), Exclude, the two switches and Save mapping. Done closes the dialog. Remove mapping deletes no file, neither locally nor on the server.
Transfer files and folders
Right-click a mapped file, a mapped folder or several entries inside one:
| Entry | Effect |
|---|---|
| Upload to (server) | new and changed files to the server |
| Download from (server) | new and changed files from the server to the Mac |
| Sync… | both directions, always with a preview |
| Compare with server | for a file: local and server version side by side. For folders: the preview of the sync. |
| Upload on save | switch for this mapping, see below |
| Transfer deleting and renaming right away | switch: deleting and renaming in the project tree also act on the server. For production always with a preview. |
| Edit the connection’s mappings … | opens the Mappings tab |
| Mappings & Sync… | opens the view for this server |
If the folder belongs to several servers, each server is a submenu of its own. In an open mapped file the bar Mapped to offers the same ways: Upload, Compare, Reload from server. ⌥⇧⌘X (Upload to …) shows the list of all targets.
How transfers work
Every transfer through a mapping is a sync with a recorded state: the editor knows what both sides looked like at the last sync.
- A file deleted here is deleted on the server when you upload, and the other way round.
- Files the server made itself and that were never synced stay.
- A file changed on both sides is a conflict. The preview shows conflicts, you decide per file. Nothing is overwritten without asking.
- A single file without a conflict goes right away; for folders and for production the preview comes first.
The preview lists what is transferred, deleted and to be decided, with the size. Deleting happens only after all transfers, backed up first. Compare in the preview opens a file as a diff. If a sync would delete more than half of one side, the editor asks Delete this much? first; usually a folder was emptied by mistake or the mapping points to the wrong place.
Upload on save
With the switch on, every ⌘S uploads the file right away. Autosave does not upload.
- Excluded files stay local; the editor says so briefly.
- If the file changed on the server since the last sync, the editor asks “…” was also changed on the server: Compare with server, Upload anyway or Don’t upload. The same goes for a file that was never synced and differs on the server.
- If the server is marked as production, turning the switch on asks Upload on save to a production server?
Protected files
No mapping transfers credentials, in either direction: .env and .env.* (except the templates .env.example and .env.dist), wp-config.php in any folder and auth.json in the mapping's top folder. If you save such a file with Upload on save, the editor tells you once per file that it is not transferred, to protect the server. Edit it directly on the server. A mapping that pairs exactly one file with another (such as .env.production with .env) still transfers it.
The Mappings & Sync view
At the top you pick the Server; servers with mappings carry a ⇅. Below, each mapping is a row with name, both paths and the last run, plus:
- Compare: by size and date, fast even with very many files, and shows what differs.
- Open: go through the mapping folder by folder, with the state of every entry (identical, changed, only local, only on server).
- Sync: both directions with the recorded state.
- Upload and Download with a choice of mode: Sync with state (default), Copy only (new and changed files; newer files at the destination stay; deletes nothing) or Mirror (also deletes at the destination what is missing at the source; you see the list first).
- Edit and delete the mapping.
- Undo last sync (…) after a run.
Before each transfer the view names the number and size of the files. More on the controls in Sync pairs in WebDonkey.
Settings
Under Settings › Remote, group Mappings:
- Always show the preview (off by default): before a single file without a conflict too.
- Mark mapped folders in the trees (on by default): a tinted background and a small mark.
If the editor finds mappings at start-up with an automatic transfer switched on that you have not confirmed in the editor yet, it asks once Mappings that transfer on their own: Set to “on command only” or Leave as is. Nothing is switched off without asking.
Free and Premium
Mappings and sync are Premium. Without Premium the view shows a notice, and the entries in the context menu are missing.
Troubleshooting
| What you see | Why | What to do |
|---|---|---|
| Everything is in sync (nothing to transfer) | Both sides are equal. | nothing |
| Nothing uploaded: … changed only on the server. | The changes are on the server. | download |
| “…” is in no mapping. | There is no mapping for this file. | create a mapping |
| Both folders need a full path starting with /. | A path is relative. | enter a full path or use Browse |
| This pair already exists for this connection. | duplicate mapping | edit the existing mapping |
See also
Server tools Premium
On a server you do more than handle files. From the Remote window you open a shell on the server, run a few git commands in a repository's folder and start Claude Code where it is installed. The editor installs nothing on the server for this.
Where to find it
In the Remote window (⌘2):
- in the list of connections: the Terminal button when you hover over a row, or Terminal in the context menu
- with an open server: Open terminal here in the header bar or in a folder's context menu, plus Git ▸ and Start Claude here where they exist
Terminal on the server
- Right-click a folder in the server tree ▸ Open terminal here.
- A new tab opens in the Terminal window below with a shell on the server, in the chosen folder. Started from the list of connections, the shell starts in the connection's start folder.
- The credentials are the connection's; you don't enter them again.
The terminal is named after the connection. If it is marked as production, the tab has a red edge. Everything else is under SSH terminal.
Git on the server
If a folder on the server is a git repository (it holds .git) and git is installed on the server, its context menu shows Git ▸ with:
| Entry | Command |
|---|---|
| Status | git status |
| Pull | git pull --ff-only |
| Changes (diff --stat) | git diff --stat |
| Log (last 20) | git log --oneline -20 |
Each command runs visibly in an SSH terminal as an editor tab, in exactly that folder. If git asks for a password or shows a pager, you answer it right there.
Claude on the server
Start Claude here opens Claude Code as an editor tab in this folder on the server. The entry appears only if the editor found claude on the server.
More tools for servers
- Edit, upload and download files: Files on the server
- Versions of PHP, Node.js and more: Server software
- Search in a server folder: On a server
- Databases of a server: in the Database window
- Backups, scheduled tasks and logs: Backups, cron jobs and logs
Free and Premium
All server tools are Premium.
Troubleshooting
| What you see | What to do |
|---|---|
| The server allows no further session (sshd: MaxSessions). | close another terminal on this server and try again |
| The terminal could not be opened on the server. | disconnect and reconnect, check the user's shell access |
| Git ▸ is missing | The folder is not a repository, or git is not installed on the server. |
| Start Claude here is missing | Claude Code is not installed on the server. |
See also
Fetch locally Free
Fetch locally copies a website from your server to this Mac: the project folder and the database come down and become a local site with a .test address in WebDonkey. So you work on a copy without touching the live server. The server is only read. In the editor, WebDonkey's page runs as a tab of its own, and Open in editor opens the finished copy right here.
Where to find it
- Command palette (⌘K): Remote: fetch locally. This works without Premium too.
- In the Remote window, in the header bar of the connection list, the menu Backups, scheduled tasks, logs ▸ Fetch a project locally (with Premium, since the Remote window is Premium).
The tab is called Fetch a project locally.
How to do it
- Pick the server under Connection. The list shows every saved connection, without Premium too. Test checks the login and shows the home folder. New connection… adds one (Server, Port, User, Name, Login with password, SSH key or SSH agent, then Save and test).
- Next to Project folder on the server, click Choose… and pick the folder of the whole project, the one with
composer.json,wp-config.phporapp/etc, not just the public folder. Choose this folder takes it. - The editor reads the project (Reading the project on the server…) and shows what it found: system and version, PHP and database, each with its version status. If your folder looks like a public folder, Use parent folder suggests the right one.
- Check Document root (relative to the project folder). If the editor finds no clear one, pick one of the suggestions or Choose…. The project folder itself applies when the website lies directly in the project folder.
- Check Name of the site and Local address (before
.test). - Pick the options (see below). If you fetch the database, confirm The copy contains real personal data, and I am allowed to fetch it to this Mac.
- Enter the Address of the live website if needed. The editor fills it from the configuration when it finds it.
- Click Fetch locally.
A pre-check runs before the start: connection, PHP on the server, project folder, document root, login to the database, way to save the database, space on the server and on the Mac, a free local target and the database service on the Mac. If everything is green, fetching starts at once. With notes only, you start with Fetch anyway. Points marked red have to be fixed first, then Check again.
Fields and options
| Option | Meaning |
|---|---|
| Fetch the database | dump on the server, download, import into a new local database. Greyed out if no database was found in the project. |
| Fetch media files | uploads and product images. Without them the copy runs, images are missing. |
| Make the copy run | Premium: switch addresses to .test (in serialised data too), Redis and search service off. The copy then runs on this Mac. |
| Address of the live website | needed in the copy's configuration. Leave it empty and WebDonkey reads it from the copy. |
| Database access | expandable: host, port, socket, name, user, password and Dump program (Automatic (recommended), a program that was found, or Without dump program (PHP)). Fields left as they are follow the project's configuration. |
WebDonkey makes every copy of Shopware 6, WordPress, WooCommerce and Magento 2 safe: database access to the local database, mails to Mailpit, scheduled tasks off, access of external services cleared. Without Make the copy run the addresses stay those of the live site. Another system with a database on the server is not fetched, because WebDonkey cannot make its copy safe.
What happens in the background
Fetching runs in steps: Read the project, Dump the database on the server, Download the dump, Download the files, Unpack the files, Create the local database, Import the dump, Add the site, Make the copy safe and Record the base state. It keeps running when you leave this page. Stop ends it and removes what was already created on this Mac.
At the end you see … is ready with address, project folder, document root, PHP and the details of the local database. Open in editor opens the copy's project folder in this editor. You open the site in the browser from WebDonkey. Done clears the view.
On the server WebDonkey only reads: it detects the project, saves the database in one read transaction and brings the project folder over packed. Personal data arrive on the Mac unchanged. If it is a client's website, your agreement with them must cover this. Protect the Mac with FileVault and delete the copy when you no longer need it.
Free and Premium
Fetching locally is free. Only Make the copy run needs Premium. The connection list on the left of the page is filled with Premium. With Free it stays empty and you pick the connection in the form.
Fetch locally needs WebDonkey on this Mac, because the copy becomes a WebDonkey site. Without WebDonkey the tab shows a notice.
Troubleshooting
| What you see | What to do |
|---|---|
| Fetching will not work like this. Fix the points marked red and check again. | fix the red points of the pre-check, their hints say how, then Check again |
| The database refused the login. | check user and password under Database access. If the website itself works, usually only the right socket or host is missing. |
| There is no suitable command line PHP on the server. | enable PHP 7.4 or newer for the command line at your host |
| Neither MySQL nor MariaDB is installed on this Mac. | install MySQL or MariaDB in WebDonkey on the Services page |
| There is not enough space on this Mac for the copy. | free up space or fetch without media files |
| Please confirm that you are allowed to fetch these personal data to your Mac. | tick the box about personal data |
| Fetching did not work. | read the details; what was created on the Mac has been removed again |
See also
Backups, cron jobs and logs Premium
WebDonkey's pages Remote backups, Scheduled tasks (server) and Server logs also run in the editor, each as a tab of its own. You back up servers and databases, manage cron jobs on the server and follow log files live without switching to WebDonkey.
Where to find it
- in the Remote window, in the header bar of the connection list, the menu Backups, scheduled tasks, logs with Remote backups, Scheduled tasks (server) and Server logs
- Tools ▸ Remote: backups, Remote: scheduled tasks, Remote: server logs
- the same three commands in the command palette (⌘K)
How to do it
- Open the page you need. It appears as a tab in the code area.
- Pick the server on the left and work as in WebDonkey. The pages run unchanged in the editor, with the same commands and the same safeguards: locked crontab with a backup, path checks, one run at a time.
The WebDonkey pages describe the controls in detail:
- Remote backups: back up server folders and databases, schedule, restore
- Remote cron jobs: create, pause and delete scheduled tasks on the server
- Remote logs: add log files on the server and follow them live
What happens in the background
The editor schedules nothing itself. Planned backups keep running through WebDonkey, otherwise a run could start twice. Each page carries the caution notice about working on servers.
Free and Premium
The three pages are Premium. Without Premium the tab shows a notice. You can pause or delete existing cron jobs on a server in WebDonkey without Premium too.
Remote backups and Scheduled tasks (server) also need WebDonkey on this Mac, because WebDonkey plans and runs them. Without WebDonkey, or if WebDonkey is older than the editor needs, the tab shows a notice instead of the page. Server logs also work without WebDonkey with a Premium license of the editor's own.
Troubleshooting
| What you see | What to do |
|---|---|
| Premium with the note about remote backups, cron jobs and logs | activate Premium |
| Without WebDonkey | install and start WebDonkey |
| WebDonkey is older than this editor needs | update WebDonkey |