Skip to content

Commit 791bff2

Browse files
committed
Readme Update: Added a "Installation" section which lists the steps for
a first time project start and visualizes the process with a short animated gif.
1 parent 09ea039 commit 791bff2

File tree

2 files changed

+43
-3
lines changed

2 files changed

+43
-3
lines changed

README.md

+43-3
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,60 @@ A dockerized version of "Magento Community Edition 1.9.x"
44

55
## Requirements
66

7-
- [docker](http://docs.docker.com/compose/install/#install-docker)
7+
Before you start you should install
8+
9+
- [docker](http://docs.docker.com/compose/install/#install-docker) and
810
- [docker-compose (formerly known as fig)](http://docs.docker.com/compose/install/#install-compose)
911

1012
or
1113

12-
you can use [vagrant](https://www.vagrantup.com/) if you like.
14+
You can use [vagrant](Vagrantfile) if you are on Windows or a Mac
15+
16+
## Installation
17+
18+
1. Make sure you have docker and docker
19+
2. Clone the repository
20+
3. Start the projects using `./magento start` or `docker-compose up`
21+
22+
```bash
23+
git clone https://github.com/andreaskoch/dockerized-magento.git && cd dockerized-magento
24+
./magento start
25+
```
26+
27+
During the first start of the project **docker-compose** will
28+
29+
1. first **build** all docker-images referenced in the [docker-compose.yml](docker-compose.yml)
30+
2. then **start** the containers
31+
3. and **trigger the installer** which will
32+
- [install magento](docker-images/installer/bin/install.sh) and all modules that are referenced in the [composer.json](composer.json) using `composer` into the web folder
33+
- download the [Magento Demo Store Sample Data](http://www.magentocommerce.com/knowledge-base/entry/installing-the-sample-data-for-magento)
34+
- copy the files to the magento-root
35+
- import the sample database
36+
- and finally reindex all indices
37+
38+
Once the installation is fininished the installer will print the URL and the credentials for the backend to the installer log:
39+
40+
```
41+
...
42+
installer_1 | Frontend: http://127.0.0.1/
43+
installer_1 | Backend: http://127.0.0.1/admin
44+
installer_1 | - Username: admin
45+
installer_1 | - Password: password123
46+
```
47+
48+
[![Animation: Installation and first projec start](documentation/installation-and-first-start-animation.gif)](https://s3.amazonaws.com/andreaskoch/dockerized-magento/installation/Dockerized-Magento-Installation-Linux-no-sound.mp4)
49+
50+
**Note**: The build process and the installation process will take a while if you start the project for the first time. After thats finished starting and stoping the project will be a matter of seconds.
1351

1452
## Usage
1553

54+
You can control the project using the built-in `magento`-script which is basically just a **wrapper for docker and docker-compose** that offers some **convenience features**:
55+
1656
```bash
1757
./magento <action>
1858
```
1959

20-
**Actons**
60+
**Available Actons**
2161

2262
- **start**: Starts the docker containers (and triggers the installation if magento is not yet installed)
2363
- **stop**: Stops all docker containers
Loading

0 commit comments

Comments
 (0)