From 86197c9b62829b9b4b6769ba806ab4a55486479a Mon Sep 17 00:00:00 2001 From: Mahmoud Zalt Date: Sun, 9 Apr 2017 14:39:25 -0400 Subject: [PATCH] update docs: Improve docker speed on MAC using dinghy --- .../_settings/content/contributing/index.md | 2 +- .../_settings/content/documentation/index.md | 49 +++++++++++-- docs/contributing/index.html | 4 +- docs/contributing/index.xml | 2 +- docs/documentation/index.html | 53 +++++++++++--- docs/documentation/index.xml | 51 +++++++++++--- docs/getting-started/index.html | 15 ++-- docs/getting-started/index.xml | 14 ++-- docs/help/index.html | 2 +- docs/index.html | 70 ++++++++++++++----- docs/index.xml | 68 ++++++++++++++---- docs/introduction/index.html | 3 +- docs/introduction/index.xml | 1 + docs/license/index.html | 2 +- docs/related-projects/index.html | 2 +- 15 files changed, 262 insertions(+), 76 deletions(-) diff --git a/DOCUMENTATION/_settings/content/contributing/index.md b/DOCUMENTATION/_settings/content/contributing/index.md index f3b67b7..0eb0cdb 100644 --- a/DOCUMENTATION/_settings/content/contributing/index.md +++ b/DOCUMENTATION/_settings/content/contributing/index.md @@ -42,7 +42,7 @@ Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Ma 1. Install [Hugo](https://gohugo.io/) on your machine (easy thing). 2. Open the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder represents a section in the menu). 3. Delete the `/docs` folder from the root. -4. When you finish editing, run the `hugo` command to generate the HTML docs (in the `/docs`). +4. When you finish editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside new `/docs` folder). ### To Host the website locally Go to `DOCUMENTATION/_settings` in your terminal and run `hugo serve` to host the website locally. diff --git a/DOCUMENTATION/_settings/content/documentation/index.md b/DOCUMENTATION/_settings/content/documentation/index.md index d810cd6..a938384 100644 --- a/DOCUMENTATION/_settings/content/documentation/index.md +++ b/DOCUMENTATION/_settings/content/documentation/index.md @@ -1349,15 +1349,36 @@ Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requ + +
## Improve speed on MacOS -Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container. +Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds: -> How to share files using NFS (d4m-nfs) +### Workaround A: using dinghy -[d4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one. +[Dinghy](https://github.com/codekitchen/dinghy) creates its own VM using docker-machine, it will not modify your existing docker-machine VMs. + +Quick Setup giude, (we recommend you check their docs) + +1) `brew tap codekitchen/dinghy` + +2) `brew install dinghy` + +3) `dinghy create --provider virtualbox` (must have virtualbox installed, but they support other providers if you prefer) + +4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM) + +5) `docker-compose up ...` + + + + +### Workaround B: using d4m-nfs + +[D4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one. 1) Update the Docker [File Sharing] preferences: @@ -1380,7 +1401,7 @@ git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs 5) Create (or edit) the file `/etc/exports`, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the `d4m-nfs.sh` script before). -6) Run the `d4m-nfs.sh` script: +6) Run the `d4m-nfs.sh` script (might need Sudo): ```bash ~/d4m-nfs/d4m-nfs.sh @@ -1389,10 +1410,26 @@ git clone https://github.com/IFSight/d4m-nfs ~/d4m-nfs That's it! Run your containers.. Example: ```bash -docker-compose up -d nginx mysql +docker-compose up ... ``` -**Note:** If you faced any errors, try restarting Docker, and make sure you have no spaces in the `d4m-nfs-mounts.txt` file, and your `/etc/exports` file is clear. +*Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the `d4m-nfs-mounts.txt` file, and your `/etc/exports` file is clear.* + + + +### Other good workarounds: + +- [docker-sync](https://github.com/EugenMayer/docker-sync) +- Add more here.. + + + + +More details about this issue [here](https://github.com/docker/for-mac/issues/77). + + + + diff --git a/docs/contributing/index.html b/docs/contributing/index.html index 311b1e1..9117ff0 100644 --- a/docs/contributing/index.html +++ b/docs/contributing/index.html @@ -10,7 +10,7 @@ Contributing - Laradock - + @@ -349,7 +349,7 @@ features, by not reporting duplicate issues.

  • Install Hugo on your machine (easy thing).
  • Open the DOCUMENTATION/_settings/content and search for the markdown file you want to edit (every folder represents a section in the menu).
  • Delete the /docs folder from the root.
  • -
  • When you finish editing, run the hugo command to generate the HTML docs (in the /docs).
  • +
  • When you finish editing, go to DOCUMENTATION/_settings/ and run the hugo command to generate the HTML docs (inside new /docs folder).
  • To Host the website locally

    diff --git a/docs/contributing/index.xml b/docs/contributing/index.xml index 11e4e2c..b4a9f15 100644 --- a/docs/contributing/index.xml +++ b/docs/contributing/index.xml @@ -52,7 +52,7 @@ features, by not reporting duplicate issues.</em></p> <li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li> <li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</li> <li>Delete the <code>/docs</code> folder from the root.</li> -<li>When you finish editing, run the <code>hugo</code> command to generate the HTML docs (in the <code>/docs</code>).</li> +<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li> </ol> <h3 id="to-host-the-website-locally">To Host the website locally</h3> diff --git a/docs/documentation/index.html b/docs/documentation/index.html index e095513..c1c162a 100644 --- a/docs/documentation/index.html +++ b/docs/documentation/index.html @@ -10,7 +10,7 @@ Documentation - Laradock - + @@ -888,6 +888,18 @@ docker-compose up -d mariadb phpmyadmin

    2 - Open your browser and visit the localhost on port 8080: http://localhost:8080

    +


    +

    + +

    Use Adminer

    + +

    1 - Run the Adminer Container (adminer) with the docker-compose up command. Example:

    + +
    docker-compose up -d adminer  
    +
    + +

    2 - Open your browser and visit the localhost on port 8080: http://localhost:8080

    +


    @@ -1401,13 +1413,27 @@ e) set it to true

    Improve speed on MacOS

    -

    Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.

    +

    Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:

    -
    -

    How to share files using NFS (d4m-nfs)

    -
    +

    Workaround A: using dinghy

    -

    d4m-nfs automatically mount NFS volume instead of osxfs one.

    +

    Dinghy creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.

    + +

    Quick Setup giude, (we recommend you check their docs)

    + +

    1) brew tap codekitchen/dinghy

    + +

    2) brew install dinghy

    + +

    3) dinghy create --provider virtualbox (must have virtualbox installed, but they support other providers if you prefer)

    + +

    4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)

    + +

    5) docker-compose up ...

    + +

    Workaround B: using d4m-nfs

    + +

    D4m-nfs automatically mount NFS volume instead of osxfs one.

    1) Update the Docker [File Sharing] preferences:

    @@ -1427,17 +1453,26 @@ e) set it to true

    5) Create (or edit) the file /etc/exports, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the d4m-nfs.sh script before).

    -

    6) Run the d4m-nfs.sh script:

    +

    6) Run the d4m-nfs.sh script (might need Sudo):

    ~/d4m-nfs/d4m-nfs.sh
     

    That’s it! Run your containers.. Example:

    -
    docker-compose up -d nginx mysql
    +
    docker-compose up ...
     
    -

    Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the d4m-nfs-mounts.txt file, and your /etc/exports file is clear.

    +

    Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the d4m-nfs-mounts.txt file, and your /etc/exports file is clear.

    + +

    Other good workarounds:

    + + + +

    More details about this issue here.


    diff --git a/docs/documentation/index.xml b/docs/documentation/index.xml index c9b3164..421db9e 100644 --- a/docs/documentation/index.xml +++ b/docs/documentation/index.xml @@ -591,6 +591,18 @@ docker-compose up -d mariadb phpmyadmin <p>2 - Open your browser and visit the localhost on port <strong>8080</strong>: <code>http://localhost:8080</code></p> +<p><br> +<a name="Use-Adminer"></a></p> + +<h2 id="use-adminer">Use Adminer</h2> + +<p>1 - Run the Adminer Container (<code>adminer</code>) with the <code>docker-compose up</code> command. Example:</p> + +<pre><code class="language-bash">docker-compose up -d adminer +</code></pre> + +<p>2 - Open your browser and visit the localhost on port <strong>8080</strong>: <code>http://localhost:8080</code></p> + <p><br> <a name="Use-pgAdmin"></a></p> @@ -1104,13 +1116,27 @@ e) set it to <code>true</code></p> <h2 id="improve-speed-on-macos">Improve speed on MacOS</h2> -<p>Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.</p> +<p>Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:</p> -<blockquote> -<p>How to share files using NFS (d4m-nfs)</p> -</blockquote> +<h3 id="workaround-a-using-dinghy">Workaround A: using dinghy</h3> -<p><a href="https://github.com/IFSight/d4m-nfs">d4m-nfs</a> automatically mount NFS volume instead of osxfs one.</p> +<p><a href="https://github.com/codekitchen/dinghy">Dinghy</a> creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.</p> + +<p>Quick Setup giude, (we recommend you check their docs)</p> + +<p>1) <code>brew tap codekitchen/dinghy</code></p> + +<p>2) <code>brew install dinghy</code></p> + +<p>3) <code>dinghy create --provider virtualbox</code> (must have virtualbox installed, but they support other providers if you prefer)</p> + +<p>4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)</p> + +<p>5) <code>docker-compose up ...</code></p> + +<h3 id="workaround-b-using-d4m-nfs">Workaround B: using d4m-nfs</h3> + +<p><a href="https://github.com/IFSight/d4m-nfs">D4m-nfs</a> automatically mount NFS volume instead of osxfs one.</p> <p>1) Update the Docker [File Sharing] preferences:</p> @@ -1130,17 +1156,26 @@ e) set it to <code>true</code></p> <p>5) Create (or edit) the file <code>/etc/exports</code>, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the <code>d4m-nfs.sh</code> script before).</p> -<p>6) Run the <code>d4m-nfs.sh</code> script:</p> +<p>6) Run the <code>d4m-nfs.sh</code> script (might need Sudo):</p> <pre><code class="language-bash">~/d4m-nfs/d4m-nfs.sh </code></pre> <p>That&rsquo;s it! Run your containers.. Example:</p> -<pre><code class="language-bash">docker-compose up -d nginx mysql +<pre><code class="language-bash">docker-compose up ... </code></pre> -<p><strong>Note:</strong> If you faced any errors, try restarting Docker, and make sure you have no spaces in the <code>d4m-nfs-mounts.txt</code> file, and your <code>/etc/exports</code> file is clear.</p> +<p><em>Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the <code>d4m-nfs-mounts.txt</code> file, and your <code>/etc/exports</code> file is clear.</em></p> + +<h3 id="other-good-workarounds">Other good workarounds:</h3> + +<ul> +<li><a href="https://github.com/EugenMayer/docker-sync">docker-sync</a></li> +<li>Add more here..</li> +</ul> + +<p>More details about this issue <a href="https://github.com/docker/for-mac/issues/77">here</a>.</p> <p><br> <a name="Common-Problems"></a></p> diff --git a/docs/getting-started/index.html b/docs/getting-started/index.html index 36a7ae1..c2fb80a 100644 --- a/docs/getting-started/index.html +++ b/docs/getting-started/index.html @@ -10,7 +10,7 @@ Getting Started - Laradock - + @@ -356,7 +356,7 @@
    • If you are not using Git yet for your project, you can use git clone instead of git submodule.

    • -
    • Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. Check this

    • +
    • Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. Check this

    Your folder structure should look like this:

    @@ -394,8 +394,9 @@

    Or you can keep default.conf as it is, and create a separate config my-site.conf file for it.

    -

    In case of Apache: :P -

    +

    In case of Apache: :P

    + +


    Now jump to the Usage section.

    @@ -448,8 +449,8 @@

    If you are using Docker Toolbox (VM), do one of the following:


    @@ -479,7 +480,7 @@

    You can select your own combination of containers form the list below:

    -

    nginx, hhvm, php-fpm, mysql, redis, postgres, mariadb, neo4j, mongo, apache2, caddy, memcached, beanstalkd, beanstalkd-console, rabbitmq, beanstalkd-console, workspace, phpmyadmin, aerospike, pgadmin, elasticsearch, rethinkdb, postgres-postgis, certbot, mailhog, minio and more…!

    +

    nginx, hhvm, php-fpm, mysql, redis, postgres, mariadb, neo4j, mongo, apache2, caddy, memcached, beanstalkd, beanstalkd-console, rabbitmq, beanstalkd-console, workspace, phpmyadmin, adminer, aerospike, pgadmin, elasticsearch, rethinkdb, postgres-postgis, certbot, mailhog, minio and more…!

    (Please note that sometimes we forget to update the docs, so check the docker-compose.yml file to see an updated list of all available containers).

    diff --git a/docs/getting-started/index.xml b/docs/getting-started/index.xml index 4bc7de3..bd2d13b 100644 --- a/docs/getting-started/index.xml +++ b/docs/getting-started/index.xml @@ -59,7 +59,7 @@ <ul> <li><p>If you are not using Git yet for your project, you can use <code>git clone</code> instead of <code>git submodule</code>.</p></li> -<li><p>Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. <a href="#keep-tracking-Laradock">Check this</a></p></li> +<li><p>Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. <a href="http://laradock.io/documentation/#keep-track-of-your-laradock-changes">Check this</a></p></li> </ul> <p>Your folder structure should look like this:</p> @@ -97,8 +97,9 @@ <p><em>Or you can keep <code>default.conf</code> as it is, and create a separate config <code>my-site.conf</code> file for it.</em></p> -<p><strong>In case of Apache:</strong> :P -<br></p> +<p><strong>In case of Apache:</strong> :P</p> + +<p><br></p> <blockquote> <p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p> @@ -151,8 +152,8 @@ <p>If you are using <strong>Docker Toolbox</strong> (VM), do one of the following:</p> <ul> -<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="#upgrading-laradock">Upgrading Laradock</a></li> -<li>Use Laradock v3.* (Visit the <code>Laradock-ToolBox</code> <a href="https://github.com/laradock/laradock/tree/Laradock-ToolBox">Branch</a>).</li> +<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="http://laradock.io/documentation/#upgrading-laradock">Upgrading Laradock</a></li> +<li>Use Laradock v3.*. Visit the <a href="https://github.com/laradock/laradock/tree/LaraDock-ToolBox">LaraDock-ToolBox</a> branch. <em>(outdated)</em></li> </ul> <p><br></p> @@ -182,7 +183,7 @@ <p>You can select your own combination of containers form the list below:</p> <blockquote> -<p><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>beanstalkd-console</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>, <code>postgres-postgis</code>, <code>certbot</code>, <code>mailhog</code>, <code>minio</code> and more&hellip;!</p> +<p><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>beanstalkd-console</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>adminer</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>, <code>postgres-postgis</code>, <code>certbot</code>, <code>mailhog</code>, <code>minio</code> and more&hellip;!</p> </blockquote> <p><em>(Please note that sometimes we forget to update the docs, so check the <code>docker-compose.yml</code> file to see an updated list of all available containers).</em></p> @@ -217,7 +218,6 @@ <p><br> 5 - Open your browser and visit your localhost address <code>http://localhost/</code>. If you followed the multiple projects setup, you can visit <code>http://project-1.dev/</code> and <code>http://project-2.dev/</code>. But first don&rsquo;t</p> - diff --git a/docs/help/index.html b/docs/help/index.html index aaf24c9..b32e679 100644 --- a/docs/help/index.html +++ b/docs/help/index.html @@ -10,7 +10,7 @@ Help & Questions - Laradock - + diff --git a/docs/index.html b/docs/index.html index d52a78d..d363e57 100644 --- a/docs/index.html +++ b/docs/index.html @@ -10,7 +10,7 @@ Laradock - + @@ -468,6 +468,7 @@ QUEUE_HOST=beanstalkd
    • PhpMyAdmin
    • +
    • Adminer
    • PgAdmin
    • ElasticSearch
    • Selenium
    • @@ -554,7 +555,7 @@ QUEUE_HOST=beanstalkd
      • If you are not using Git yet for your project, you can use git clone instead of git submodule.

      • -
      • Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. Check this

      • +
      • Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. Check this

      Your folder structure should look like this:

      @@ -592,8 +593,9 @@ QUEUE_HOST=beanstalkd

      Or you can keep default.conf as it is, and create a separate config my-site.conf file for it.

      -

      In case of Apache: :P -

      +

      In case of Apache: :P

      + +


      Now jump to the Usage section.

      @@ -646,8 +648,8 @@ QUEUE_HOST=beanstalkd

      If you are using Docker Toolbox (VM), do one of the following:


      @@ -677,7 +679,7 @@ QUEUE_HOST=beanstalkd

      You can select your own combination of containers form the list below:

      -

      nginx, hhvm, php-fpm, mysql, redis, postgres, mariadb, neo4j, mongo, apache2, caddy, memcached, beanstalkd, beanstalkd-console, rabbitmq, beanstalkd-console, workspace, phpmyadmin, aerospike, pgadmin, elasticsearch, rethinkdb, postgres-postgis, certbot, mailhog, minio and more…!

      +

      nginx, hhvm, php-fpm, mysql, redis, postgres, mariadb, neo4j, mongo, apache2, caddy, memcached, beanstalkd, beanstalkd-console, rabbitmq, beanstalkd-console, workspace, phpmyadmin, adminer, aerospike, pgadmin, elasticsearch, rethinkdb, postgres-postgis, certbot, mailhog, minio and more…!

      (Please note that sometimes we forget to update the docs, so check the docker-compose.yml file to see an updated list of all available containers).

      @@ -1293,6 +1295,18 @@ docker-compose up -d mariadb phpmyadmin

      2 - Open your browser and visit the localhost on port 8080: http://localhost:8080

      +


      +

      + +

      Use Adminer

      + +

      1 - Run the Adminer Container (adminer) with the docker-compose up command. Example:

      + +
      docker-compose up -d adminer  
      +
      + +

      2 - Open your browser and visit the localhost on port 8080: http://localhost:8080

      +


      @@ -1806,13 +1820,27 @@ e) set it to true

      Improve speed on MacOS

      -

      Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.

      +

      Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:

      -
      -

      How to share files using NFS (d4m-nfs)

      -
      +

      Workaround A: using dinghy

      -

      d4m-nfs automatically mount NFS volume instead of osxfs one.

      +

      Dinghy creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.

      + +

      Quick Setup giude, (we recommend you check their docs)

      + +

      1) brew tap codekitchen/dinghy

      + +

      2) brew install dinghy

      + +

      3) dinghy create --provider virtualbox (must have virtualbox installed, but they support other providers if you prefer)

      + +

      4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)

      + +

      5) docker-compose up ...

      + +

      Workaround B: using d4m-nfs

      + +

      D4m-nfs automatically mount NFS volume instead of osxfs one.

      1) Update the Docker [File Sharing] preferences:

      @@ -1832,17 +1860,26 @@ e) set it to true

      5) Create (or edit) the file /etc/exports, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the d4m-nfs.sh script before).

      -

      6) Run the d4m-nfs.sh script:

      +

      6) Run the d4m-nfs.sh script (might need Sudo):

      ~/d4m-nfs/d4m-nfs.sh
       

      That’s it! Run your containers.. Example:

      -
      docker-compose up -d nginx mysql
      +
      docker-compose up ...
       
      -

      Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the d4m-nfs-mounts.txt file, and your /etc/exports file is clear.

      +

      Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the d4m-nfs-mounts.txt file, and your /etc/exports file is clear.

      + +

      Other good workarounds:

      + + + +

      More details about this issue here.


      @@ -1947,6 +1984,7 @@ These Docker Compose projects have piqued our interest:

      I have a Question/Problem

      If you have questions about how to use Laradock, please direct your questions to the discussion on Gitter. If you believe your question could help others, then consider opening an Issue (it will be labeled as Question) And you can still seek help on Gitter for it.

      +

      I found an Issue

      If have an issue or you found a typo in the documentation, you can help us by @@ -1977,7 +2015,7 @@ features, by not reporting duplicate issues.

    • Install Hugo on your machine (easy thing).
    • Open the DOCUMENTATION/_settings/content and search for the markdown file you want to edit (every folder represents a section in the menu).
    • Delete the /docs folder from the root.
    • -
    • When you finish editing, run the hugo command to generate the HTML docs (in the /docs).
    • +
    • When you finish editing, go to DOCUMENTATION/_settings/ and run the hugo command to generate the HTML docs (inside new /docs folder).
    • To Host the website locally

      diff --git a/docs/index.xml b/docs/index.xml index 379f212..4134ef7 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -170,6 +170,7 @@ QUEUE_HOST=beanstalkd <ul> <li>PhpMyAdmin</li> +<li>Adminer</li> <li>PgAdmin</li> <li>ElasticSearch</li> <li>Selenium</li> @@ -261,7 +262,7 @@ QUEUE_HOST=beanstalkd <ul> <li><p>If you are not using Git yet for your project, you can use <code>git clone</code> instead of <code>git submodule</code>.</p></li> -<li><p>Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. <a href="#keep-tracking-Laradock">Check this</a></p></li> +<li><p>Note 2: To keep track of your Laradock changes, between your projects and also keep Laradock updated. <a href="http://laradock.io/documentation/#keep-track-of-your-laradock-changes">Check this</a></p></li> </ul> <p>Your folder structure should look like this:</p> @@ -299,8 +300,9 @@ QUEUE_HOST=beanstalkd <p><em>Or you can keep <code>default.conf</code> as it is, and create a separate config <code>my-site.conf</code> file for it.</em></p> -<p><strong>In case of Apache:</strong> :P -<br></p> +<p><strong>In case of Apache:</strong> :P</p> + +<p><br></p> <blockquote> <p><strong>Now jump to the <a href="#Usage">Usage</a> section.</strong></p> @@ -353,8 +355,8 @@ QUEUE_HOST=beanstalkd <p>If you are using <strong>Docker Toolbox</strong> (VM), do one of the following:</p> <ul> -<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="#upgrading-laradock">Upgrading Laradock</a></li> -<li>Use Laradock v3.* (Visit the <code>Laradock-ToolBox</code> <a href="https://github.com/laradock/laradock/tree/Laradock-ToolBox">Branch</a>).</li> +<li>Upgrade to Docker <a href="https://www.docker.com/products/docker">Native</a> for Mac/Windows (Recommended). Check out <a href="http://laradock.io/documentation/#upgrading-laradock">Upgrading Laradock</a></li> +<li>Use Laradock v3.*. Visit the <a href="https://github.com/laradock/laradock/tree/LaraDock-ToolBox">LaraDock-ToolBox</a> branch. <em>(outdated)</em></li> </ul> <p><br></p> @@ -384,7 +386,7 @@ QUEUE_HOST=beanstalkd <p>You can select your own combination of containers form the list below:</p> <blockquote> -<p><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>beanstalkd-console</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>, <code>postgres-postgis</code>, <code>certbot</code>, <code>mailhog</code>, <code>minio</code> and more&hellip;!</p> +<p><code>nginx</code>, <code>hhvm</code>, <code>php-fpm</code>, <code>mysql</code>, <code>redis</code>, <code>postgres</code>, <code>mariadb</code>, <code>neo4j</code>, <code>mongo</code>, <code>apache2</code>, <code>caddy</code>, <code>memcached</code>, <code>beanstalkd</code>, <code>beanstalkd-console</code>, <code>rabbitmq</code>, <code>beanstalkd-console</code>, <code>workspace</code>, <code>phpmyadmin</code>, <code>adminer</code>, <code>aerospike</code>, <code>pgadmin</code>, <code>elasticsearch</code>, <code>rethinkdb</code>, <code>postgres-postgis</code>, <code>certbot</code>, <code>mailhog</code>, <code>minio</code> and more&hellip;!</p> </blockquote> <p><em>(Please note that sometimes we forget to update the docs, so check the <code>docker-compose.yml</code> file to see an updated list of all available containers).</em></p> @@ -1005,6 +1007,18 @@ docker-compose up -d mariadb phpmyadmin <p>2 - Open your browser and visit the localhost on port <strong>8080</strong>: <code>http://localhost:8080</code></p> +<p><br> +<a name="Use-Adminer"></a></p> + +<h2 id="use-adminer">Use Adminer</h2> + +<p>1 - Run the Adminer Container (<code>adminer</code>) with the <code>docker-compose up</code> command. Example:</p> + +<pre><code class="language-bash">docker-compose up -d adminer +</code></pre> + +<p>2 - Open your browser and visit the localhost on port <strong>8080</strong>: <code>http://localhost:8080</code></p> + <p><br> <a name="Use-pgAdmin"></a></p> @@ -1518,13 +1532,27 @@ e) set it to <code>true</code></p> <h2 id="improve-speed-on-macos">Improve speed on MacOS</h2> -<p>Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container.</p> +<p>Sharing code into Docker containers with osxfs have very poor performance compared to Linux. Likely there are some workarounds:</p> -<blockquote> -<p>How to share files using NFS (d4m-nfs)</p> -</blockquote> +<h3 id="workaround-a-using-dinghy">Workaround A: using dinghy</h3> -<p><a href="https://github.com/IFSight/d4m-nfs">d4m-nfs</a> automatically mount NFS volume instead of osxfs one.</p> +<p><a href="https://github.com/codekitchen/dinghy">Dinghy</a> creates its own VM using docker-machine, it will not modify your existing docker-machine VMs.</p> + +<p>Quick Setup giude, (we recommend you check their docs)</p> + +<p>1) <code>brew tap codekitchen/dinghy</code></p> + +<p>2) <code>brew install dinghy</code></p> + +<p>3) <code>dinghy create --provider virtualbox</code> (must have virtualbox installed, but they support other providers if you prefer)</p> + +<p>4) after the above command is done it will display some env variables, copy them to the bash profile or zsh or.. (this will instruct docker to use the server running inside the VM)</p> + +<p>5) <code>docker-compose up ...</code></p> + +<h3 id="workaround-b-using-d4m-nfs">Workaround B: using d4m-nfs</h3> + +<p><a href="https://github.com/IFSight/d4m-nfs">D4m-nfs</a> automatically mount NFS volume instead of osxfs one.</p> <p>1) Update the Docker [File Sharing] preferences:</p> @@ -1544,17 +1572,26 @@ e) set it to <code>true</code></p> <p>5) Create (or edit) the file <code>/etc/exports</code>, make sure it exists and is empty. (There may be collisions if you come from Vagrant or if you already executed the <code>d4m-nfs.sh</code> script before).</p> -<p>6) Run the <code>d4m-nfs.sh</code> script:</p> +<p>6) Run the <code>d4m-nfs.sh</code> script (might need Sudo):</p> <pre><code class="language-bash">~/d4m-nfs/d4m-nfs.sh </code></pre> <p>That&rsquo;s it! Run your containers.. Example:</p> -<pre><code class="language-bash">docker-compose up -d nginx mysql +<pre><code class="language-bash">docker-compose up ... </code></pre> -<p><strong>Note:</strong> If you faced any errors, try restarting Docker, and make sure you have no spaces in the <code>d4m-nfs-mounts.txt</code> file, and your <code>/etc/exports</code> file is clear.</p> +<p><em>Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the <code>d4m-nfs-mounts.txt</code> file, and your <code>/etc/exports</code> file is clear.</em></p> + +<h3 id="other-good-workarounds">Other good workarounds:</h3> + +<ul> +<li><a href="https://github.com/EugenMayer/docker-sync">docker-sync</a></li> +<li>Add more here..</li> +</ul> + +<p>More details about this issue <a href="https://github.com/docker/for-mac/issues/77">here</a>.</p> <p><br> <a name="Common-Problems"></a></p> @@ -1705,12 +1742,13 @@ features, by not reporting duplicate issues.</em></p> <li>Install <a href="https://gohugo.io/">Hugo</a> on your machine (easy thing).</li> <li>Open the <code>DOCUMENTATION/_settings/content</code> and search for the markdown file you want to edit (every folder represents a section in the menu).</li> <li>Delete the <code>/docs</code> folder from the root.</li> -<li>When you finish editing, run the <code>hugo</code> command to generate the HTML docs (in the <code>/docs</code>).</li> +<li>When you finish editing, go to <code>DOCUMENTATION/_settings/</code> and run the <code>hugo</code> command to generate the HTML docs (inside new <code>/docs</code> folder).</li> </ol> <h3 id="to-host-the-website-locally">To Host the website locally</h3> <p>Go to <code>DOCUMENTATION/_settings</code> in your terminal and run <code>hugo serve</code> to host the website locally.</p> + <h3 id="edit-the-sidebar">Edit the sidebar</h3> <p>To add a new section to the sidebar or edit existing one, you need to edit this file <code>DOCUMENTATION/_settings/config.toml</code>.</p> diff --git a/docs/introduction/index.html b/docs/introduction/index.html index 65b9543..310d38c 100644 --- a/docs/introduction/index.html +++ b/docs/introduction/index.html @@ -10,7 +10,7 @@ Introduction - Laradock - + @@ -467,6 +467,7 @@ QUEUE_HOST=beanstalkd
      • PhpMyAdmin
      • +
      • Adminer
      • PgAdmin
      • ElasticSearch
      • Selenium
      • diff --git a/docs/introduction/index.xml b/docs/introduction/index.xml index 0e8bf66..ac0cba0 100644 --- a/docs/introduction/index.xml +++ b/docs/introduction/index.xml @@ -170,6 +170,7 @@ QUEUE_HOST=beanstalkd <ul> <li>PhpMyAdmin</li> +<li>Adminer</li> <li>PgAdmin</li> <li>ElasticSearch</li> <li>Selenium</li> diff --git a/docs/license/index.html b/docs/license/index.html index bb4df69..d96f7a8 100644 --- a/docs/license/index.html +++ b/docs/license/index.html @@ -10,7 +10,7 @@ License - Laradock - + diff --git a/docs/related-projects/index.html b/docs/related-projects/index.html index 3664149..7a5a75a 100644 --- a/docs/related-projects/index.html +++ b/docs/related-projects/index.html @@ -10,7 +10,7 @@ Related Projects - Laradock - +