Skip to content

Commit 46ba345

Browse files
committed
Update documentation
1 parent 8857653 commit 46ba345

File tree

5 files changed

+42
-12
lines changed

5 files changed

+42
-12
lines changed

Diff for: documentation/docs/content/gettingStarted/index.rst

+26-3
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,39 @@ Getting Started
66
Requirements
77
------------
88

9-
This section is not done yet!
9+
* Docker host (eg. Vagrant Docker VM or dinghy)
10+
* Docker compose
1011

1112
------------
1213
Installation
1314
------------
1415

15-
This section is not done yet!
16+
Clone the boilerplate and link or copy ``docker-compose.development.yml``
17+
18+
.. code-block:: bash
19+
20+
git clone https://github.com/webdevops/php-docker-boilerplate.git project
21+
cd project
22+
cp docker-compose.development.yml docker-compose.yml
1623
1724
-----
1825
Usage
1926
-----
2027

21-
This section is not done yet!
28+
Startup containers and run the services:
29+
30+
.. code-block:: bash
31+
32+
docker-compose up -d
33+
34+
------------------------------
35+
Web access (dinghy http proxy)
36+
------------------------------
37+
38+
If you're using dinghy docker](https://github.com/codekitchen/dinghy) you can access the services via
39+
40+
- Application: http://app.boilerplate.docker/
41+
- Mailhog: http://mail.boilerplate.docker
42+
- PHPMyAdmin: http://pma.boilerplate.docker
43+
- Solr: http://solr.boilerplate.docker
44+
- Elasticsearch: http://elasticsearch.boilerplate.docker

Diff for: documentation/docs/content/introduction.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
Introduction
33
============
44

5-
Introduction Content
6-
75
---------------------------------------
86
What is the PHP Docker Boilerplate for?
97
---------------------------------------
108

11-
This section is not done yet!
9+
This PHP Docker Boilerplate is for an example layout for an PHP application with most common services like MySQL or
10+
Postgres and with a development and production context and settings.

Diff for: documentation/docs/content/usage/dockerCompose.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
Docker Compose Configuration
33
============================
44

5-
This section is not done yet!
5+
Inside the `docker-compose.*.yml` files the service layout and links between the layout can be defined.
6+
7+
For some services also the version can be chosen, eg. `MySQL-5.7.Dockerfile`

Diff for: documentation/docs/content/usage/dockerImages.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
======================
2-
Altering Docker Images
3-
======================
1+
=========================
2+
Customizing Docker Images
3+
=========================
4+
5+
The main `Dockerfile.*` for the php application container can be customized as any normal Dockerfile image.
46

5-
This section is not done yet!

Diff for: documentation/docs/content/usage/vagrantDockerVM.rst

+6-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,9 @@
22
Synergy with Vagrant Docker VM
33
==============================
44

5-
This section is not done yet!
5+
The [Vagrant Docker VM](https://github.com/webdevops/vagrant-docker-vm) (Ubuntu 16.04) is using
6+
[dinghy docker](https://github.com/codekitchen/dinghy) for providing an automatic and dynamic reverse proxy
7+
which makes easy to start multiple instances of the boilerplate.
8+
9+
You can also use [dinghy docker](https://github.com/codekitchen/dinghy) standalone if you don't need
10+
an full Linux environment.

0 commit comments

Comments
 (0)