Buy

Fetch locally

Free & Premium

On the Fetch locally page you copy a website from your server to this Mac and work on it locally. Project folder and database come over SSH and become a site with a .test address under Sites. The server is only read. Fetch locally works without Premium. With Premium, WebDonkey also makes the copy run.

What you do here

  • choose connection, project folder, document root, name and options in the form
  • see with the pre-check whether fetching will work before anything is created on your Mac
  • follow the run and result and open the finished copy in the browser or editor

Page layout

  • Header: Fetch locally with the sentence Copy a website from your server to this Mac and work on it locally.
  • On the left the Connections list as on the other Remote pages (with Premium). A click on a server restarts the form with that connection. In Free the list stays empty, and you choose the connection in the form.
  • On the right the Fetch a project locally card with the form. While a run is going, it shows the progress instead (Fetching …).

How to do it

  1. In the sidebar, open Remote › Fetch locally, or type "Fetch locally" into ⌘K.
  2. Choose the Connection and click Test, or create one with New connection….
  3. Pick the Project folder on the server with Choose…. WebDonkey reads the project and shows what it found.
  4. Check Document root (relative to the project folder), Name of the site and Local address.
  5. Decide on Fetch the database, Fetch media files and Make the copy run.
  6. With a database, confirm the note about personal data.
  7. Click Fetch locally. The pre-check runs first, then the fetch.

Which projects work

Project What happens
Shopware 6, WordPress, WooCommerce, Magento 2 files and database are fetched, and the copy is always made safe
other projects without a database or with SQLite files are fetched, and the site is added
other systems with a database on the server (such as Laravel, Symfony, Drupal, TYPO3) are not fetched, because WebDonkey cannot safely switch their configuration to a local database

Only MySQL and MariaDB databases are fetched.

Free and Premium

Free Premium
Fetch files and database, create the site yes yes
Make the copy safe (local database, mails to Mailpit, scheduled tasks off, access of external services cleared) yes yes
Choose or create a connection in the form yes yes
Connection list on the left empty yes
Make the copy run (addresses on .test, Redis and search service off) no yes

Without Premium the copy keeps the addresses of the live website. What else Premium unlocks is listed under Free, Premium and limits.

Personal data

If you fetch the database, the website's personal data arrive on this Mac unchanged: customers, orders, accounts and everything else the database stores. That is why WebDonkey asks for your confirmation first. If it is a client's website, your agreement with them must cover this (data processing agreement). Protect the Mac with FileVault and delete the copy when you no longer need it.

The form Free & Premium

In the Fetch a project locally form you decide what comes from the server and what the copy on your Mac is called. The fields appear step by step: first the connection, then the project folder. Only once WebDonkey has read the project do the document root, name and options follow.

Where to find it

Sidebar Remote › Fetch locally. The form is the card on the right.

How to do it

  1. Connection: choose the server from the list. Each line shows the name and user@host. Test logs in and shows Connected. Home folder: … on success.
  2. Project folder on the server: click Choose… or into the field. In the Choose the project folder dialog you click a folder to go into it, Up goes one level up, and Choose this folder takes it.
  3. WebDonkey reads the project (Reading the project on the server…) and shows a box with the result.
  4. Check Document root (relative to the project folder).
  5. Adjust Name of the site and Local address.
  6. Choose the options.
  7. With a database, tick the confirmation about personal data.
  8. Click Fetch locally.

The folder meant is the one of the whole project, with composer.json, wp-config.php or app/etc, not only the public folder. If you choose a folder that looks like a public folder, the box suggests the parent folder: Use parent folder takes it.

Create a new connection

New connection… opens a small dialog that works in Free too:

Field Meaning
Server Address of the server. Required.
Port Default 22
User SSH user. Required.
Name Display name. Empty uses user@host.
Login with Password, SSH key or SSH agent
Key file with SSH key, default ~/.ssh/id_ed25519
Passphrase (if any) with SSH key
Password with Password. Required.

Save and test saves the connection and logs in once. The password is stored encrypted on this Mac. If the login fails, the connection is still saved (The connection is saved but the server could not be reached.), and Test again tries once more. The new connection then shows on all other Remote pages too.

What WebDonkey finds in the project

The box after reading shows:

  • the system with version and edition, such as Shopware or WordPress, with a mark for its support state,
  • PHP with the version the project uses on the server,
  • Database with the name and database server, also with a mark,
  • notes in yellow, for example when the database could not be reached from the server or no dump program was found.

The marks at the versions mean the same as in server software.

Fields and options

Field Meaning Default
Document root (relative to the project folder) the public folder of the website, relative to the project folder, such as public. . means the project folder itself. Choose… opens Choose the document root. detected. If it is not clear, WebDonkey offers suggestions as buttons, and the field is required.
Name of the site Name in the list of sites suggested from the project
Local address the part before .test. "My Shop" becomes my-shop.test. If the name is taken, WebDonkey adds -2, -3 … from the name
Fetch the database fetches the database and creates a local one. Disabled with No database found in the project. if there is none. on if the project has a database
Fetch media files uploads and product images. Without them the copy runs, images are missing. on
Make the copy run rewrite addresses to .test (in serialised data too), Redis and search service off. The copy then runs on this Mac. Premium only, in Free it carries the Premium mark. on with Premium
Address of the live website only for Shopware 6, WordPress, WooCommerce and Magento 2. Taken from the configuration when found. Left empty, WebDonkey reads it from the copy. Must start with http:// or https://. found or empty

Below the options it says what happens to the copy while Make the copy run is off: The copy is made safe (with a database), or that an empty local database is created (without one).

The confirmation about personal data

If you fetch the database, a box with a yellow border appears: The copy contains real personal data, and I am allowed to fetch it to this Mac. Without the tick, Fetch locally stays disabled. WebDonkey remembers the tick for this connection and this project folder, so it is already set next time.

Advanced: Database access

Below the form, Advanced expands the Database access. Usually you do not need it, WebDonkey reads the access details from the project's configuration (.env.local, wp-config.php, env.php …). Above the fields it says where the values come from: Prefilled from … with the file, Prefilled from the environment variables of the server or Saved for this project.

Field Meaning
Host, Port, Socket how the project reaches the database
Database, User the database name and the database user
Password leave it empty to keep the saved one or the one from the configuration
Dump program Automatic (recommended), one of the programs found with its version, Without dump program (PHP) or Own path…. does not match the server marks a MySQL program for a MariaDB server and the other way round.

Test connection logs in with these details and shows the result as a list. Save remembers them (Saved. The next check uses this access.), Back to the configuration deletes what was saved. Fields you leave as they are keep following the configuration. The access applies per connection and project folder, the password is stored encrypted on this Mac and only goes to the server over the SSH connection, never on a command line.

If the pre-check fails at the database, the Database access expands by itself.

Troubleshooting

What you see What you do
No connection yet in the list Create one with New connection…
No clear document root found: please give it. Click a suggestion or give the folder with Choose…
The document root has to lie inside the project folder. Choose a folder inside the project folder
WebDonkey cannot make a copy of this project safe The system has a database on the server and cannot be switched safely. Fetch it without the database or set it up by hand.
Please give a full address such as https://www.example.com. Enter the live address with https:// or empty the field
Note More than one WordPress below the chosen folder Choose the folder of one of the installs

See also

Pre-check Free

Before anything is created on this Mac, WebDonkey checks whether fetching will work: connection, PHP on the server, project folder, database, free space on both sides and the local target. Every point that does not fit names the reason and the way out. As long as a point is red, nothing starts.

Where to find it

Sidebar Remote › Fetch locally. The check starts when you click Fetch locally in the form. While it runs, it says Checking whether fetching will work….

How to do it

  1. Fill in the form and click Fetch locally.
  2. Read the result above the buttons:
    • Everything is ready. Fetching starts right away.
    • Fetching will work. Mind the notes. At least one point is yellow. The button now reads Fetch anyway and starts with the next click.
    • Fetching will not work like this. Fix the points marked red and check again. Nothing starts.
  3. Fix the red points and click Check again.

A check only applies to exactly the details it ran with. If you change something in the form afterwards, WebDonkey checks again on the next click.

The points of the check

Each point shows a green tick, a yellow warning sign or a red sign, plus the reason and what to do.

Point What is checked
Connection to the server the SSH login and whether WebDonkey's helper starts on the server
PHP on the server a command line PHP, 7.4 or newer
Project folder readable whether the SSH user may read the project folder
Document root present whether the document root exists in the project folder
Login to the database login with the details from the configuration or the saved database access
Way to save the database a matching dump program, otherwise the way through PHP
Space on the server for the dump free space in the home folder on the server
Space on this Mac free space for the dump, archive, files and local database
Local target free whether the name and address of the copy are free
Database service on this Mac whether MySQL or MariaDB is installed

Without a database the database points are left out.

Free space

The two space points show per disk what the run needs and what is free: Needs about …, plus … reserve and free … of …. As the reserve, at least 500 MB stay free after the run, for large copies 15 % of what the run writes there. Yellow means Tight, but it fits, red says how much is missing. On the Mac it also says how much of it macOS frees by itself when needed (caches, for example). If the server reports a storage quota, its free space counts.

What happens in the background

  • The check only reads. On the server it looks at the project folder, the database and the space, on the Mac at the space and the existing sites. Nothing is created.
  • For Way to save the database, WebDonkey briefly tries every matching dump program on the server (mysqldump, mariadb-dump and the usual places at hosting providers), the closest version first. It does not use programs that do not match the database server. If none works, it reads the database with PHP. That takes longer, the result is the same.
  • On hosts with several database servers WebDonkey connects the same way as the website itself, also through the socket the database server names.
  • A run that starts without this check checks the database itself at its start and stops just as early.

Troubleshooting

What you see What you do
The server cannot be reached or refuses the login. Check the connection with Test and your login details
The WebDonkey helper could not be started on the server. Look at Details. Another PHP version at your host often helps.
There is no suitable command line PHP on the server. Enable PHP 7.4 or newer for the command line at your host
This user may not read the project folder. Connect with the user the project belongs to
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 database with this name on the server. Enter the right name under Database access
The database server could not be reached. Enter the host and port, or the website's socket, under Database access
The PHP on the server lacks the extension pdo_mysql. Choose a PHP version with pdo_mysql at your host
No matching dump program found. (yellow) Nothing needed, WebDonkey uses PHP. If you know a program, enter it under Database access.
Neither MySQL nor MariaDB is installed on this Mac. Install MySQL or MariaDB under Services
The name is taken. The copy gets another one. (yellow) Nothing needed, or choose another name
Not enough space on the server or the Mac Free up space or untick Fetch media files

If the server reports an error, it shows as a plain sentence. Details expands the server's message.

See also

Run and result Free

Once the pre-check has passed, WebDonkey fetches the database and files, creates the local database, makes the copy safe and adds it as a site. The card shows every step, the free space during the run and at the end everything you need to start working.

Where to find it

Sidebar Remote › Fetch locally. As soon as a run starts, the card shows Fetching … with the list of steps instead of the form. The run goes on when you leave the page. When you come back, you see its state again.

The steps

Step What happens
Read the project WebDonkey reads the project once more and checks the database
Dump the database on the server a dump of the database is made on the server, in a read transaction
Download the dump the dump comes to the Mac and is deleted on the server right away
Download the files the project folder comes over as one packed archive, the card shows the amount already loaded
Unpack the files the archive is unpacked into the folder of the new site
Create the local database a new database with its own user and password, in MySQL or MariaDB on this Mac
Import the dump the dump goes into the local database
Make the copy safe the configuration points to the local database, mails go to Mailpit, scheduled tasks are off, access of external services is cleared. With Premium WebDonkey also makes the copy run here.
Add the site the copy appears under Sites with its .test address

If you do not fetch a database, the database steps are left out. For Shopware 6, WordPress, WooCommerce and Magento 2 an empty local database is still created, so the copy never reaches the live database or the live mail server.

Disk space during the run

Below the steps, Disk space during the run shows what the run still needs. Before every big step WebDonkey measures the space again and only starts the step if the reserve stays free afterwards (at least 500 MB). Getting tight and Almost full warn beforehand. If the space is not enough, the run stops, removes what it created and reports it in the bell.

Stop

Stop halts the run between two steps or while importing. WebDonkey then removes what was created on this Mac: the folder, the local database and its user. The same happens when a step fails. Nothing changes on the server in any case.

The result

At the end it says … is ready with these details:

Detail Content
Address the local address, https://…test or http://…test
Project folder the copy's folder in the Default Sites Root
Document root the copy's public folder
PHP the site's PHP version
Database name, kind, host and port of the local database
User, Password the access to the local database

Above them are short sentences, such as Contains real personal data., Made safe: local database, mails to Mailpit, scheduled tasks off. or Configuration rewritten for this Mac. (with Premium). Notes in yellow say what you should still check.

  • Open starts what the site needs and opens it in the browser.
  • Open in editor opens the project folder in the code editor.
  • Done closes the result and shows the form again.

You also find the site under Sites afterwards.

What happens in the background

  • The server is only read: the project, a dump in a read transaction and an archive of the project folder. WebDonkey deletes the dump there as soon as it is on the Mac.
  • Caches and logs of the system do not come along (the folders stay, empty). Without Fetch media files the media folders are missing.
  • The copy's name and address are always free: if shop.test is taken, it becomes shop-2.test.
  • The address gets HTTPS as long as your limit for sites with HTTPS allows it (3 in Free), otherwise HTTP.
  • If the server's PHP version is missing on your Mac, the site uses the default PHP.
  • If WebDonkey cannot confirm that the copy's database and mail stay local, it removes the copy again.

Troubleshooting

What you see What you do
Fetching did not work. What was created on this Mac has been removed. Read the reason below it, Details shows the server's message. Fix it and fetch again.
Note The PHP version of the server is not installed here Install the matching PHP version under Services and assign it to the site
Note Mailpit is not installed Install Mailpit under Services, otherwise the copy's mails go nowhere
Note Webserver or PHP could not be started yet. Start the services under Services
Note Not every point of the configuration could be confirmed. Check the copy before you use it
Note about the Deployer layout Links to releases and shared folders may point to server paths. Check the links in the project folder.
A copy of this website is being created right now. Wait for the running run
The sites folder in the settings is not an absolute path. Under Settings › Sites & services, choose an absolute folder at Default Sites Root

See also

Cookie preferences

This website uses cookies to ensure the best experience possible. Your choice applies to webdonkey.io and the shop at shop.webdonkey.io. More information...

Technically required

Cookies required for this website to function:

Always on
WebDonkey
WebDonkey
Provider: BuI Hinsche GmbH, Neumarkt 7, 06712 Zeitz, Germany
Purpose: Your consent, colour scheme and language for website and shop, price switches; with wd_debug in the address, the measurement events in the developer console for troubleshooting
Cookies and storage: Cookie wd_consent on .webdonkey.io, shared with shop.webdonkey.io (12 months); cookies wd_theme and wd_lang on .webdonkey.io, shared with shop.webdonkey.io, only when you switch colour scheme or language yourself (365 days); localStorage wd:consent, wd:theme, wd:lang; sessionStorage wd:acc, wd:term, wd:debug (only with wd_debug in the address; until the tab closes)

Statistics

Shows us which pages and products people look at on webdonkey.io and in the shop, where visitors come from and how they get to a purchase (with order number, amount and products, without name or email address). Provider: Google. Transfer to the USA possible (EU-US Data Privacy Framework). Your choice applies to webdonkey.io and the shop together.

Google Tag Manager, Google Analytics 4
Google Tag Manager
Provider: Google Ireland Limited, Gordon House, Barrow Street, Dublin 4, Ireland
Purpose: Loads the services you agreed to, here and in the shop. Sets no cookies of its own.
Cookies and storage: none
Privacy policy
Google Analytics 4
Provider: Google Ireland Limited, Gordon House, Barrow Street, Dublin 4, Ireland
Purpose: Usage statistics: page views, clicks, scroll depth, sources, devices, load times; in the shop also basket, checkout, purchases, registration and sign-in
Cookies and storage: _ga, _ga_<ID> (2 years)
Privacy policy

Marketing

Measures whether our ads on Facebook, Instagram and TikTok lead to visits and downloads on webdonkey.io and to registrations and purchases in the shop, and builds audiences for ads. Providers: Meta and TikTok, with whom we are jointly responsible for this. With this consent Google may also set advertising cookies (_gcl_…). Transfer to the USA and other countries outside the EU possible. Your choice applies to webdonkey.io and the shop together.

Google Tag Manager, Meta Pixel (Facebook, Instagram), TikTok Pixel
Google Tag Manager
Provider: Google Ireland Limited, Gordon House, Barrow Street, Dublin 4, Ireland
Purpose: Loads the services you agreed to, here and in the shop. Sets no cookies of its own.
Cookies and storage: none
Privacy policy
Meta Pixel (Facebook, Instagram)
Provider: Meta Platforms Ireland Limited, Merrion Road, Dublin 4, D04 X2K5, Ireland
Purpose: Ad measurement and target groups on Facebook and Instagram, also in the shop (basket, checkout, purchases, registration)
Cookies and storage: _fbp (3 months), _fbc (3 months, only if you arrive through an ad), fr on facebook.com (3 months)
Privacy policy
TikTok Pixel
Provider: TikTok Technology Limited, 10 Earlsfort Terrace, Dublin, D02 T380, Ireland
Purpose: Ad measurement and target groups on TikTok, also in the shop (basket, checkout, purchases, registration)
Cookies and storage: _ttp, _tt_enable_cookie (13 months)
Privacy policy