Getting started

docs/getting-started/create-env-file.rst

@@ -0,0 +1,6 @@
+****************
+Create .env file
+****************
+
+
+Syncronize file permissions

docs/getting-started/create-your-first-project.rst

@@ -0,0 +1,3 @@
+*************************
+Create your first project
+*************************

docs/getting-started/docker-version.rst

@@ -0,0 +1,91 @@
+.. _docker_version:
+
+**************
+Docker version
+**************
+
+Before going to proceed with the devilbox installation and setup, make sure you meet the requirements.
+
+Requirements
+============
+
+Both ``Docker`` and ``Docker Compose`` is required for the devilbox to work. Whether you go with the
+recommended or not recommended Docker version is up to you. Most important part is to pay attention to
+the version number.
+
+You **must** have at least the following versions or above:
+
+* ``Docker``: 1.12.0
+* ``Docker Compose``: 1.9.0
+
+Additionally you require ``git`` in order to clone the devilbox project later on.
+
+
+Recommended Docker versions
+---------------------------
+
+Do use native Docker and do not rely on Docker Toolbox whenever possible.
+
++--------------------+------------------------+----------------------------+------------------------+
+|                    | |logo_lin|             | |logo_win|                 | |logo_osx|             |
++====================+========================+============================+========================+
+| **Docker**         | `Docker`_ |br|         | `Docker for Windows`_ |br| | `Docker for Mac`_ |br| |
+|                    | 1.12.0+                | 1.12.0+                    | 1.12.0+                |
++--------------------+------------------------+----------------------------+------------------------+
+| **Docker Compose** | `Docker Compose`_ |br| | `Docker Compose`_ |br|     | `Docker Compose`_ |br| |
+|                    | 1.9.0+                 | 1.9.0+                     | 1.9.0+                 |
++--------------------+------------------------+----------------------------+------------------------+
+
+.. |logo_lin| image:: https://raw.githubusercontent.com/cytopia/icons/master/64x64/linux.png
+.. |logo_osx| image:: https://raw.githubusercontent.com/cytopia/icons/master/64x64/osx.png
+.. |logo_win| image:: https://raw.githubusercontent.com/cytopia/icons/master/64x64/windows.png
+.. _Docker: https://docs.docker.com/install
+.. _Docker for Windows: https://docs.docker.com/docker-for-windows/install
+.. _Docker for Mac: https://docs.docker.com/docker-for-mac/install
+.. _Docker Compose: https://docs.docker.com/compose/install/
+
+Not recommended Docker versions
+-------------------------------
+
+In case you are not able to use a native Docker versions (such as on Windows 7), your only chance
+is to install the ``Docker Toolbox``.
+
+Validate installed versions
+---------------------------
+
+If you are going with the supported or unsupported Docker versions is up to you
+
+Once you have installed Docker and Docker Compose, ensure you have the required minimum version.
+
+.. code-block:: bash
+
+    $ docker version
+
+
+    Client:
+     Version:       18.02.0-ce
+     API version:   1.36
+     Go version:    go1.9.3
+     Git commit:    fc4de44
+     Built: Wed Feb  7 21:16:24 2018
+     OS/Arch:       linux/amd64
+     Experimental:  false
+     Orchestrator:  swarm
+
+    Server:
+     Engine:
+      Version:      18.02.0-ce
+      API version:  1.36 (minimum version 1.12)
+      Go version:   go1.9.3
+      Git commit:   fc4de44
+      Built:        Wed Feb  7 21:14:54 2018
+      OS/Arch:      linux/amd64
+      Experimental: false
+
+Supported versions
+------------------
+
+
+.. |br| raw:: html
+
+   <br />

docs/getting-started/installation.rst

@@ -0,0 +1,43 @@
+************
+Installation
+************
+
+Install Requirements
+====================
+
+Both ``Docker`` and ``Docker Compose`` are required for the devilbox to run. They are
+available for Linux, Windows and MacOS. Below are their minimum required versions:
+
+* ``Docker``: 1.12.0+
+* ``Docker Compose``: 1.9.0+
+
+Paste the following two commands into your terminal to validate your version:
+
+.. code-block:: console
+
+   docker --version
+   docker-compose --version
+
+
+Additionally you will require ``git`` in order to clone the devilbox project.
+
+.. warning::
+   :ref:`docker_version`
+      Use **native Docker** and do not use the **Docker Toolbox**. If you still have to use the
+      Docker Toolbox (e.g. for Windows 7) read up on this section.
+
+
+Download the devilbox
+=====================
+
+The devilbox does not need to be installed. The only thing that is required is its git directory.
+To download that, open a terminal and copy/paste the following command.
+
+.. code-block:: console
+
+   git clone https://github.com/cytopia/devilbox
+
+That's it, you have finished the first section.
+
+
+.. seealso:: :ref:`docker_version`

docs/getting-started/start-the-devilbox.rst

@@ -0,0 +1,3 @@
+******************
+Start the Devilbox
+******************