From b01e967a9f2526365c71c49cdebf16bda43cd7fd Mon Sep 17 00:00:00 2001
From: crystaldust <juzhenatpku@gmail.com>
Date: Wed, 23 Apr 2014 03:29:17 +0000
Subject: [PATCH] Add the configs comments, and update the README.md file

---
 dockerfiles/README.md | 39 +++++++++++----------------------------
 dockerfiles/build.sh  | 16 +++++++---------
 2 files changed, 18 insertions(+), 37 deletions(-)

diff --git a/dockerfiles/README.md b/dockerfiles/README.md
index 97c5aa053..2989bd36a 100644
--- a/dockerfiles/README.md
+++ b/dockerfiles/README.md
@@ -1,11 +1,14 @@
-### Gogs Install With Docker
+### Install Gogs With Docker
 
-Deply gogs in [Docker](http://www.docker.io/) is just as easy as eating a pie, what you do is just open the `dockerfiles/build.sh` file, replace the confis:
+Deplying gogs in [Docker](http://www.docker.io/) is just as easy as eating a pie, what you do is just open the `dockerfiles/build.sh` file, replace the confis:
 
 ```
-MYSQL_PASSWORD="YOUR_MYSQL_PASSWORD"
-MYSQL_RUN_NAME="YOUR_MYSQL_RUN_NAME"
-HOST_PORT="YOUR_HOST_PORT"
+DB_TYPE="YOUR_DB_TYPE"            # type of database, support 'mysql' and 'postgres'
+MEM_TYPE="YOUR_MEM_TYPE"          # type of memory database, support 'redis' and 'memcache'
+DB_PASSWORD="YOUR_DB_PASSWORD"    # The database password.
+DB_RUN_NAME="YOUR_DB_RUN_NAME"    # The --name option value when run the database image.
+MEM_RUN_NAME="YOUR_MEM_RUN_NAME"  # The --name option value when run the mem database image.
+HOST_PORT="YOUR_HOST_PORT"        # The port on host, which will be redirected to the port 3000 inside gogs container.
 ```
 
 And run:
@@ -18,13 +21,13 @@ The build might take some time, just be paient. After it finishes, you will rece
 
 ```
 Now we have the MySQL image(running) and gogs image, use the follow command to start gogs service( the content might be different, according to your own configs):
- docker run -i -t --link gogs_mysql:db -p 3333:3000 gogs/gogits
+ docker run -i -t --link YOUR_DB_RUN_NAME:db  --link YOUR_MEM_RUN_NAME:mem  -p YOUR_HOST_PORT:3000 gogits/gogs 
 ```
 
 Just follow the message, run:
 
 ```
- docker run -i -t --link gogs_mysql:db -p 3333:3000 gogs/gogits
+ docker run -i -t --link YOUR_DB_RUN_NAME:db  --link YOUR_MEM_RUN_NAME:mem  -p YOUR_HOST_PORT:3000 gogits/gogs 
 ```
 
 Now we have gogs running! Open the browser and navigate to:
@@ -34,24 +37,4 @@ http://YOUR_HOST_IP:YOUR_HOST_PORT
 ```
 
 Let's 'gogs'!
-
-#### Gogs With MySQL
-
-
-#### Gogs With PostgreSQL
-
-
-#### Gogs, MySQL With Redis
-
-
-#### Gogs, MySQL With Memcached
-
-
-#### Gogs, PostgreSQL With Redis
-
-
-#### Gogs, PostgreSQL With Memcached
-
-
-
-
+Ouya~
diff --git a/dockerfiles/build.sh b/dockerfiles/build.sh
index d6fb8f5fe..83f7e9a56 100755
--- a/dockerfiles/build.sh
+++ b/dockerfiles/build.sh
@@ -1,17 +1,15 @@
 # Configs of the docker images, you might have specify your own configs here.
 
-# type of database, support 'mysql' and 'postgres'
-DB_TYPE="YOUR_DB_TYPE"
-# type of memory database, support 'redis' and 'memcache'
-MEM_TYPE="YOUR_MEM_TYPE"
+DB_TYPE="YOUR_DB_TYPE"            # type of database, support 'mysql' and 'postgres'
+MEM_TYPE="YOUR_MEM_TYPE"          # type of memory database, support 'redis' and 'memcache'
+DB_PASSWORD="YOUR_DB_PASSWORD"    # The database password.
+DB_RUN_NAME="YOUR_DB_RUN_NAME"    # The --name option value when run the database image.
+MEM_RUN_NAME="YOUR_MEM_RUN_NAME"  # The --name option value when run the mem database image.
+HOST_PORT="YOUR_HOST_PORT"        # The port on host, which will be redirected to the port 3000 inside gogs container.
+
 # apt source, you can select 'nchc'(mirror in Taiwan) or 'aliyun'(best for mainlance China users) according to your network, if you could connect to the official unbunt mirror in a fast speed, just leave it to "".
 APT_SOURCE=""
 
-DB_PASSWORD="YOUR_DB_PASSWORD"
-DB_RUN_NAME="YOUR_DB_RUN_NAME"
-MEM_RUN_NAME="YOUR_MEM_RUN_NAME"
-HOST_PORT="YOUR_HOST_PORT"
-
 # Replace the database root password in database image Dockerfile.
 sed -i "s/THE_DB_PASSWORD/$DB_PASSWORD/g" images/$DB_TYPE/Dockerfile
 # Replace the database root password in gogits image deploy.sh file.