Selaa lähdekoodia

Updated README with composer-less verbiage

Mark Shust 9 vuotta sitten
vanhempi
commit
d05c47136e
1 muutettua tiedostoa jossa 32 lisäystä ja 18 poistoa
  1. 32 18
      README.md

+ 32 - 18
README.md

@@ -2,17 +2,20 @@ This docker-compose.yml file is provided by Mage Inferno
 
 Author: Mark Shust <mark.shust@mageinferno.com>
 
-# Docker Hub
+## Docker Hub
+
 View our Docker Hub images at [https://hub.docker.com/u/mageinferno/](https://hub.docker.com/u/mageinferno/)
 
-# Usage
+## Usage
+
 This file is provided as an example development environment using Mage Inferno Magento 2 Docker Images. We suggest to supply specific version releases as this will maintain a consistent development environment (nginx:1.9 vs. nginx).
 
 Create a new folder to house your project, ex: `~/Sites/mysite` then, please your docker-compose.yml file within this directory.
 
 Setup will create a new directory at `~/Sites/mysite/src` which will hold all of the source files for Magento 2.
 
-# Composer Setup
+## Composer Setup
+
 This setup attaches the `~/.composer` directory from the host machine. For fully automated setup, please first setup a GitHub Personal Access Token for Composer (before running setup) by visiting <a href="https://github.com/settings/tokens/new?scopes=repo&description=Composer" target="_blank">https://github.com/settings/tokens/new?scopes=repo&description=Composer</a>.
 
 You'll also need to retrieve your Magento development keys. Please see <a href="http://devdocs.magento.com/guides/v2.0/install-gde/prereq/connect-auth.html" target="_blank">http://devdocs.magento.com/guides/v2.0/install-gde/prereq/connect-auth.html</a> for more details.
@@ -33,35 +36,46 @@ After both sets of keys are retrieved, place your auth token on your host machin
 }
 ```
 
-# Running Setup
+## Composer-less, No-Auth Setup
+
+If you don't want to use Composer or setup the auth keys above, no worries. Magento provides a complete Magento 2 archive at <a href="http://devdocs.magento.com/guides/v2.0/install-gde/prereq/zip_install.html" target="_blank">http://devdocs.magento.com/guides/v2.0/install-gde/prereq/zip_install.html</a>. We decided to use this method for a very quick installation.
+
+Just specify the full version (2.x.x), for example `2.0.0` for an install without sample data, or `2.0.0-sd` for an install with sample data.
+
+Note that the abbreviated (2.x) version, for example `2.0`, is reserved for the Composer install process.
+
+## Running Setup
+
 Before running Magento 2, you must download the source code, install composer dependencies, and execute the Magento installer script. Luckily, Mage Inferno makes this easy for you.
 
 The following environment variables can be set for setup:
 ```
-      - M2SETUP_DB_HOST=db
-      - M2SETUP_DB_NAME=magento2
-      - M2SETUP_DB_USER=magento2
-      - M2SETUP_DB_PASSWORD=magento2
-      - M2SETUP_BASE_URL=http://mysite.docker/
-      - M2SETUP_ADMIN_FIRSTNAME=Admin
-      - M2SETUP_ADMIN_LASTNAME=User
-      - M2SETUP_ADMIN_EMAIL=dummy@gmail.com
-      - M2SETUP_ADMIN_USER=magento2
-      - M2SETUP_ADMIN_PASSWORD=magento2
-      - M2SETUP_USE_SAMPLE_DATA=true
+- M2SETUP_DB_HOST=db
+- M2SETUP_DB_NAME=magento2
+- M2SETUP_DB_USER=magento2
+- M2SETUP_DB_PASSWORD=magento2
+- M2SETUP_BASE_URL=http://mysite.docker/
+- M2SETUP_ADMIN_FIRSTNAME=Admin
+- M2SETUP_ADMIN_LASTNAME=User
+- M2SETUP_ADMIN_EMAIL=dummy@gmail.com
+- M2SETUP_ADMIN_USER=magento2
+- M2SETUP_ADMIN_PASSWORD=magento2
+- M2SETUP_USE_SAMPLE_DATA=true
 ```
 
-Our setup script uses these variables to determine how to setup your store. Everything is pretty self-explanatory.
+Our setup script uses these variables to determine how to setup your store. Everything is pretty self-explanatory. The `M2_USE_SAMPLE_DATA` variable is only used with Composer-based installs.
 
 To run setup, execute the following command from your project directory (`~/Sites/mysite`), which creates a one-off throw away container that sets up Magento 2 for you.
 `docker-compose run --rm setup`
 
 Note that setup will take around 30 minutes to complete. A vast majority of this time is from downloading Composer dependencies, and installing sample data (configurable products, specifically). Setting `M2SETUP_USE_SAMPLE_DATA` to false will expedite the install process by skipping the installation of sample data.
 
-# Data Volumes
+## Data Volumes
+
 This install will mount the `src` directory from your host machine to the Docker container (ex: `~/Sites/mysite/src`). Note that the persistancy comes from your host machine, so you may terminate running nginx/php containers and start them back up, and your data will remain. The `appdata` definition in the docker-compose.yml file is mainly there so we only have to define the relation in one place in the file, instead of it being defined multiple times.
 
 For MySQL, the `mysqldata` container runs from the `tianon/true` volume. This makes a persistent Docker volume, however be aware that removing this container will remove all of your MySQL data (aka your database). Even though it appears as exited/stopped when running `docker ps -a`, be sure not to remove this container, as your MySQL data will truly go away if you remove it.
 
-# App Virtual Host
+## App Virtual Host
+
 This docker-compose file is catered to [Dinghy](https://github.com/codekitchen/dinghy), which uses it's own DNS Server and HTTP Proxy. Notice the `VIRTUAL_HOST=mysite.docker` definition for the `app` container. Dinghy uses this to create an HTTP Proxy, so your site can be access at [http://mysite.docker](http://mysite.docker). Note that all virtual names must end in `.docker` for proper DNS resolution by Dinghy.