Skip to content

Commit fe7de5e

Browse files
committed
Update README
1 parent 21db1bc commit fe7de5e

File tree

1 file changed

+40
-4
lines changed

1 file changed

+40
-4
lines changed

README.md

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,51 @@
1-
# Docker Web App Boilerplate
1+
# Docker Web Stack
2+
3+
---
24

35
## What's inside
6+
47
A `docker-compose`-powered stack to get your PHP web app project running.
58

69
- PHP-FPM 7.1
710
- nginx
811
- MariaDB
912
- Node w/ Yarn
1013

14+
---
15+
1116
## Requirements
12-
_In progress..._
1317

14-
## How-to
15-
_In progress..._
18+
- `Docker` v17.03.1-ce or higher
19+
- `docker-compose` v1.11.2 or higher
20+
21+
---
22+
23+
## How-to (simple)
24+
25+
To start the stack, run:
26+
27+
docker-compose up -d --build --remove-orphans
28+
29+
- The `-d` flag daemonises the stack.
30+
- The `--build` builds services (e.g. `php-fpm`, `nginx`) that comprise the stack.
31+
- The `--remove-orphans` stack ensures that services that aren't being used are deleted (to save disk space).
32+
33+
---
34+
35+
## How-to (advanced)
36+
37+
### Re-building a service
38+
39+
If you want to extend the functionality of a service (e.g. php-fpm), you have to re-build it.
40+
41+
To accomplish this, modify the Dockerfile, then run:
42+
43+
docker-compose build --no-cache --force-rm [name-of-service]
44+
45+
... followed by a `docker-compose up [arguments...]`
46+
47+
---
48+
49+
## Warranties
50+
51+
- This stack was built on `macOS Sierra` v10.12.5. Experience may very on other operating systems.

0 commit comments

Comments
 (0)