Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 1335281

Browse files
author
Steve Johnson
authored
Add information about DevBox file sharing (#606)
* Add info about shared files * Add info about shared files * Add info about shared files
1 parent adc7190 commit 1335281

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

guides/v2.0/install-gde/docker/docker-ref.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Before you continue, make sure you install and configure the following:
4949
</div>
5050

5151
#### Set up Docker file sharing {#devbox-docker-file-share}
52-
For the Magento application to work, the application must be installed in a directory that Docker uses for file sharing.
52+
For the Magento application to work, the application must be installed in a folder that Docker uses for file sharing.
5353

5454
**Windows**
5555

@@ -72,24 +72,39 @@ To set up Docker file sharing on the Mac OS:
7272
2. From the pop-up menu, click **Preferences**.
7373
3. In the Preferences dialog box, click the **File Sharing** tab.
7474

75-
This tab page displays all shared directories that Docker currently knows about. Make sure you install Magento in a directory listed on this tab page.
75+
This tab page displays all shared directories that Docker currently knows about. Make sure you install Magento in a folder listed on this tab page.
7676
5. To add additional directories, follow the prompts on your screen or consult Docker documentation.
7777

7878
{% endcollapsibleh2 %}
7979

80+
<p id="devbox-fileshare"></p>{% collapsibleh2 How DevBox uses file sharing %}
81+
82+
DevBox runs in a Docker container, which is also referred to as the _guest operating system_. The Magento files and folders are located on your _host operating system_ (Windows or Mac OS). To facilitate development, Magento files and directories are shared by the guest and host operating systems.
83+
84+
When you make a change to files, the changes are automatically synchronized, regardless of which files you change. (In other words, if you change files on the host operating system, those files are synchronized with the guest operating system and vice versa.)
85+
86+
Use the following guidelines:
87+
88+
* New Magento DevBox installations: Files are shared in the `shared/webroot` folder relative to your Magento installation root folder.
89+
90+
The Magento installation root folder is typically a subfolder of the folder in which you extracted the `.zip` file you download from Magento.
91+
* If you use an existing Magento installation with DevBox: Files are shared in the location to which you downloaded Magento.
92+
93+
{% endcollapsibleh2 %}
94+
8095
{% collapsibleh2 Magento authentication prerequisites %}
8196

8297
{% include install/auth-tokens-get.md %}
8398

8499
{% endcollapsibleh2 %}
85100

86-
<p id="devbox-download">{% collapsibleh2 How to download Magento code %}
101+
<p id="devbox-download"></p>{% collapsibleh2 How to download Magento code %}
87102

88103
This section applies to you if you use an existing Magento installation with DevBox. This means you first download the Magento software using either [Composer]({{ page.baseurl }}install-gde/prereq/integrator_install.html) or a [compressed archive]({{ page.baseurl }}install-gde/prereq/zip_install.html) but you don't _install_ the software.
89104

90105
Downloading a compressed archive has potential issues on the Mac OS, which extracts known compressed file types like `.zip` to a folder. The folder contains files that have to be copied in a particular way; otherwise, the Magento DevBox doesn't perform properly.
91106

92-
If you download a compressed archive on the Mac OS, you must make sure to copy _all_ of the Magento code to an empty folder. In particular, you must copy all Apache [distributed configuration files](http://httpd.apache.org/docs/current/howto/htaccess.html){:target="_blank"}, named `.htaccess`, to the folder. `.htaccess` files are located in several Magento directories, including in the root directory.
107+
If you download a compressed archive on the Mac OS, you must make sure to copy _all_ of the Magento code to an empty folder. In particular, you must copy all Apache [distributed configuration files](http://httpd.apache.org/docs/current/howto/htaccess.html){:target="_blank"}, named `.htaccess`, to the folder. `.htaccess` files are located in several Magento directories, including in the root folder.
93108

94109
Failure to copy `.htaccess` files causes the Magento application to function incorrectly because URL redirects won't work.
95110

@@ -99,7 +114,7 @@ When you download a file on the Mac OS, the file is usually located in the `/Use
99114
/Users/&lt;name>/Downloads/&lt;Magento folder name>
100115
</pre>
101116

102-
To make sure your existing Magento installation works it with DevBox, create an empty directory and copy all of the contents of the Magento compressed file to it as follows:
117+
To make sure your existing Magento installation works it with DevBox, create an empty folder and copy all of the contents of the Magento compressed file to it as follows:
103118

104119
<pre class="no-copy">
105120
mkdir -p &lt;path>
@@ -109,7 +124,7 @@ cp -r /Users/&lt;name>/Downloads/&lt;Magento folder name> &lt;path></pre>
109124
Don't use arguments like `/*` in the `cp` command because hidden files like `.htaccess` won't copy.
110125
</div>
111126

112-
For example, to copy Magento CE 2.1.3 code to a new directory named `/Users/me/Applications/Magento`, use the following commands:
127+
For example, to copy Magento CE 2.1.3 code to a new folder named `/Users/me/Applications/Magento`, use the following commands:
113128

114129
mkdir -p /Users/me/Applications/Magento
115130
cp -r /Users/me/Downloads/Magento-CE-2_1_3_zip-2016-12-16-06-04-03 /Users/me/Applications/Magento
@@ -236,6 +251,15 @@ To provide you more control over your Magento installation, we enable you to cho
236251

237252
{% endcollapsibleh2 %}
238253

254+
## After the DevBox wizard completes
255+
After you finish the DevBox wizard, you're prompted to download a `.zip` file to any folder on your system. When you extract the `.zip` file, your operating system might create another folder.
256+
257+
A Windows example follows:
258+
259+
C:\magento\build-18c4e4d3c5a541f37e9cffd35f1bf74e\build-18c4e4d3c5a541f37e9cffd35f1bf74e
260+
261+
In the preceding example, the user downloaded `build-18c4e4d3c5a541f37e9cffd35f1bf74e.zip` to the `C:\magento` folder. Extracting the `.zip` created a subfolder. The installation script you must run is located in the subfolder.
262+
239263
<div class="bs-callout bs-callout-info" markdown="1">
240264
When you run the installation script on Windows, an additional command window opens for Unison sync. You don't normally need to interact with this command window.
241265

0 commit comments

Comments
 (0)