Skip to content

Commit 935ad61

Browse files
committed
text improvements
1 parent a8cacc7 commit 935ad61

File tree

1 file changed

+29
-21
lines changed

1 file changed

+29
-21
lines changed

README.md

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
## Apache Docker
23

34
[![Run Status](https://api.shippable.com/projects/54cf015b5ab6cc13528a7b6a/badge?branch=master)](https://app.shippable.com/projects/54cf015b5ab6cc13528a7b6a)
@@ -6,9 +7,9 @@
67
[![Beerpay](https://beerpay.io/htmlgraphic/Apache/badge.svg?style=beer)](https://beerpay.io/htmlgraphic/Apache) [![Beerpay](https://beerpay.io/htmlgraphic/Apache/make-wish.svg?style=flat)](https://beerpay.io/htmlgraphic/Apache)
78

89

9-
This repo will give you a turn key Docker container build for use in production OR local development. The setup includes an Apache web service, PHP 7.3, PHP Composer, linked [MySQL 5.7.26](https://hub.docker.com/_/mysql) instance and a data container volume.
10+
This repo will give you a turn key Docker container build for use in **production** OR **dev**. The setup includes an Apache web service, PHP 7.3, PHP Composer, linked [MySQL 5.7.26](https://hub.docker.com/_/mysql) instance and a data container volume.
1011

11-
In this repo you will find a number of complete Dockerfile builds used in **development** and **production** environments. Listed below is an explanation of each file. [Ask a question!](https://github.com/htmlgraphic/Apache/issues/new)
12+
In this repo you will find a number of complete Dockerfile builds used in **dev** or **production** environments. Listed below is an explanation of each file. [Ask a question!](https://github.com/htmlgraphic/Apache/issues/new)
1213

1314
#### Dependencies
1415
- Docker [Download](https://hub.docker.com/search/?type=edition&offering=community)
@@ -32,7 +33,7 @@ Apache # → Root of Docker Build
3233
├── .env.example # → Rename file to `.env` for local environment variables used within build
3334
├── .circleci/ # → CircleCI 2.0
3435
│ └── config.yml # → CircleCI Config
35-
├── docker-compose.local.yml #Local build
36+
├── docker-compose.local.yml #Dev build
3637
├── docker-compose.yml # → Production build
3738
├── Dockerfile # → Uses a basefile build to help speed up the docker container build process
3839
├── Makefile # → Build command shortcuts
@@ -49,34 +50,37 @@ Launch the **Apache** instance locally and setup a local MySQL database containe
4950

5051
The **Apache** container the directory `/data` is shared to your local system via **Line 7** within `docker-container.local.yml` file
5152

53+
### Mac OS X / Linux
54+
5255
> Type `make` for more build options:
5356
5457
```bash
55-
$ git clone https://github.com/htmlgraphic/Apache.git ~/Docker/Apache && cd ~/Docker/Apache
56-
$ cp .env.example .env
57-
$ make run
58-
OR (non Make Windows)
58+
> git clone https://github.com/htmlgraphic/Apache.git ~/Docker/Apache && cd ~/Docker/Apache
59+
> cp .env.example .env
60+
> make run
61+
```
5962

60-
$ copy .env.example .env
61-
$ docker-compose -f docker-compose.local.yml up -d
63+
### (non Make Windows)
64+
```bash
65+
> copy .env.example .env
66+
> docker-compose -f docker-compose.local.yml up -d
6267
```
6368

64-
### Run phpMyAdmin
6569

66-
Review MySQL access instructions upon `make run` command execution. Setup phpMyAdmin directly via command line.
70+
## phpMyAdmin
71+
72+
Review MySQL access instructions upon `make run` command execution. Setup phpMyAdmin directly via command line. https://localhost:8080
6773

6874
```bash
69-
$ docker run --name myadmin -d --link apache_db:db --net apache_default -p 8080:80 phpmyadmin/phpmyadmin
75+
> docker run --name myadmin -d --link apache_db:db --net apache_default -p 8080:80 phpmyadmin/phpmyadmin
7076
```
7177

72-
LOCAL: https://localhost:8080
73-
7478
Login using the following creditial stored within the .env file:
7579

7680
|username |password |
7781
|--|--|
78-
|root | $new_passwordac
79-
|$MYSQL_PASSWORD |$MYSQL_PASSWORD |
82+
|root | `$MYSQL_ROOT_PASSWORD`
83+
|`$MYSQL_PASSWORD` |`$MYSQL_PASSWORD` |
8084

8185

8286

@@ -93,7 +97,7 @@ These continuous integration services will fully test the creation of your conta
9397
**[Shippable](https://shippable.com)** - Test **production** and **dev** Docker builds, can the container be built the without error? The ```/tests/build_tests.sh``` file ensures the can run with parameters defined. Shippable allows the use of [matrix environment variables](http://docs.shippable.com/ci_configure/#using-environment-variables) reducing build time and offer a more robust tests. If any test(s) fail the system should be reviewed closer.
9498

9599

96-
## Interacting with containers:
100+
## Interacting with Containers:
97101

98102
List all running containers:
99103

@@ -105,7 +109,7 @@ List all containers (including stopped containers):
105109
`docker ps -a`
106110

107111

108-
Read the log of a running container:
112+
Review og of a running container:
109113

110114
`docker logs [CONTAINER ID OR NAME]`
111115

@@ -150,8 +154,12 @@ Stop and start a container in separate operations:
150154
## Teardown
151155
#### (Stop all running containers started by Docker Compose):
152156

157+
### Mac OS X / Linux
158+
```bash
159+
> make rm
153160
```
154-
$ make rm
155-
OR (non Make Windows)
156-
$ docker rm -f apache_web && docker rm -f apache_db
161+
162+
### (non Make Windows)
163+
```bash
164+
> docker-compose stop
157165
```

0 commit comments

Comments
 (0)