Selaa lähdekoodia

updated Wordpress example to be easier to follow, added/updated images

docs update per Mary's comments on the PR

Signed-off-by: Victoria Bialas <[email protected]>
Victoria Bialas 9 vuotta sitten
vanhempi
sitoutus
e6797e1166

+ 2 - 3
docs/django.md

@@ -10,10 +10,9 @@ weight=4
 <![end-metadata]-->
 
 
-# Quickstart: Compose and Django
+# Quickstart: Docker Compose and Django
 
-This quick-start guide demonstrates how to use Compose to set up and run a
-simple Django/PostgreSQL app. Before starting, you'll need to have
+This quick-start guide demonstrates how to use Docker Compose to set up and run a simple Django/PostgreSQL app. Before starting, you'll need to have
 [Compose installed](install.md).
 
 ## Define the project components

+ 1 - 1
docs/gettingstarted.md

@@ -12,7 +12,7 @@ weight=-85
 
 # Getting Started
 
-On this page you build a simple Python web application running on Compose. The
+On this page you build a simple Python web application running on Docker Compose. The
 application uses the Flask framework and increments a value in Redis. While the
 sample uses Python, the concepts demonstrated here should be understandable even
 if you're not familiar with it.

BIN
docs/images/django-it-worked.png


BIN
docs/images/rails-welcome.png


BIN
docs/images/wordpress-files.png


BIN
docs/images/wordpress-lang.png


BIN
docs/images/wordpress-welcome.png


+ 2 - 2
docs/rails.md

@@ -9,9 +9,9 @@ weight=5
 +++
 <![end-metadata]-->
 
-## Quickstart: Compose and Rails
+## Quickstart: Docker Compose and Rails
 
-This Quickstart guide will show you how to use Compose to set up and run a Rails/PostgreSQL app. Before starting, you'll need to have [Compose installed](install.md).
+This Quickstart guide will show you how to use Docker Compose to set up and run a Rails/PostgreSQL app. Before starting, you'll need to have [Compose installed](install.md).
 
 ### Define the project
 

+ 120 - 75
docs/wordpress.md

@@ -10,88 +10,133 @@ weight=6
 <![end-metadata]-->
 
 
-# Quickstart: Compose and WordPress
+# Quickstart: Docker Compose and WordPress
 
-You can use Compose to easily run WordPress in an isolated environment built
-with Docker containers.
+You can use Docker Compose to easily run WordPress in an isolated environment built
+with Docker containers. This quick-start guide demonstrates how to use Compose to set up and run WordPress. Before starting, you'll need to have
+[Compose installed](install.md).
 
 ## Define the project
 
-First, [Install Compose](install.md) and then download WordPress into the
-current directory:
-
-    $ curl https://wordpress.org/latest.tar.gz | tar -xvzf -
-
-This will create a directory called `wordpress`. If you wish, you can rename it
-to the name of your project.
-
-Next, inside that directory, create a `Dockerfile`, a file that defines what
-environment your app is going to run in. For more information on how to write
-Dockerfiles, see the
-[Docker user guide](https://docs.docker.com/engine/userguide/dockerimages/#building-an-image-from-a-dockerfile) and the
-[Dockerfile reference](https://docs.docker.com/engine/reference/builder/). In
-this case, your Dockerfile should be:
-
-    FROM orchardup/php5
-    ADD . /code
-
-This tells Docker how to build an image defining a container that contains PHP
-and WordPress.
-
-Next you'll create a `docker-compose.yml` file that will start your web service
-and a separate MySQL instance:
-
-    version: '2'
-    services:
-      web:
-        build: .
-        command: php -S 0.0.0.0:8000 -t /code
-        ports:
-          - "8000:8000"
-        depends_on:
-          - db
-        volumes:
-          - .:/code
-      db:
-        image: orchardup/mysql
-        environment:
-          MYSQL_DATABASE: wordpress
-
-A supporting file is needed to get this working. `wp-config.php` is
-the standard WordPress config file with a single change to point the database
-configuration at the `db` container:
-
-    <?php
-    define('DB_NAME', 'wordpress');
-    define('DB_USER', 'root');
-    define('DB_PASSWORD', '');
-    define('DB_HOST', "db:3306");
-    define('DB_CHARSET', 'utf8');
-    define('DB_COLLATE', '');
-
-    define('AUTH_KEY',         'put your unique phrase here');
-    define('SECURE_AUTH_KEY',  'put your unique phrase here');
-    define('LOGGED_IN_KEY',    'put your unique phrase here');
-    define('NONCE_KEY',        'put your unique phrase here');
-    define('AUTH_SALT',        'put your unique phrase here');
-    define('SECURE_AUTH_SALT', 'put your unique phrase here');
-    define('LOGGED_IN_SALT',   'put your unique phrase here');
-    define('NONCE_SALT',       'put your unique phrase here');
-
-    $table_prefix  = 'wp_';
-    define('WPLANG', '');
-    define('WP_DEBUG', false);
-
-    if ( !defined('ABSPATH') )
-        define('ABSPATH', dirname(__FILE__) . '/');
-
-    require_once(ABSPATH . 'wp-settings.php');
+1. Create an empty project directory.
+
+    You can name the directory something easy for you to remember. This directory is the context for your application image. The directory should only contain resources to build that image.
+
+    This project directory will contain a `Dockerfile`, a `docker-compose.yaml` file, along with a downloaded `wordpress` directory and a custom `wp-config.php`, all of which you will create in the following steps.
+
+2. Change directories into your project directory.
+
+    For example, if you named your directory `my_wordpress`:
+
+        $ cd my-wordpress/
+
+3. Create a `Dockerfile`, a file that defines the environment in which your application will run.
+
+    For more information on how to write Dockerfiles, see the [Docker Engine user guide](https://docs.docker.com/engine/userguide/dockerimages/#building-an-image-from-a-dockerfile) and the [Dockerfile reference](https://docs.docker.com/engine/reference/builder/).
+
+    In this case, your Dockerfile should include these two lines:
+
+        FROM orchardup/php5
+        ADD . /code
+
+    This tells the Docker Engine daemon how to build an image defining a container that contains PHP and WordPress.
+
+4. Create a `docker-compose.yml` file that will start your web service and a separate MySQL instance:
+
+        version: '2'
+        services:
+          web:
+            build: .
+            command: php -S 0.0.0.0:8000 -t /code/wordpress/
+            ports:
+              - "8000:8000"
+            depends_on:
+              - db
+            volumes:
+              - .:/code
+          db:
+            image: orchardup/mysql
+            environment:
+              MYSQL_DATABASE: wordpress
+
+5. Download WordPress into the current directory:
+
+        $ curl https://wordpress.org/latest.tar.gz | tar -xvzf -
+
+    This creates a directory called `wordpress` in your project directory.
+
+6. Create a `wp-config.php` file within the `wordpress` directory.
+
+    A supporting file is needed to get this working. At the top level of the wordpress directory, add a new file called `wp-config.php` as shown. This is the standard WordPress config file with a single change to point the database configuration at the `db` container:
+
+        <?php
+        define('DB_NAME', 'wordpress');
+        define('DB_USER', 'root');
+        define('DB_PASSWORD', '');
+        define('DB_HOST', "db:3306");
+        define('DB_CHARSET', 'utf8');
+        define('DB_COLLATE', '');
+
+        define('AUTH_KEY',         'put your unique phrase here');
+        define('SECURE_AUTH_KEY',  'put your unique phrase here');
+        define('LOGGED_IN_KEY',    'put your unique phrase here');
+        define('NONCE_KEY',        'put your unique phrase here');
+        define('AUTH_SALT',        'put your unique phrase here');
+        define('SECURE_AUTH_SALT', 'put your unique phrase here');
+        define('LOGGED_IN_SALT',   'put your unique phrase here');
+        define('NONCE_SALT',       'put your unique phrase here');
+
+        $table_prefix  = 'wp_';
+        define('WPLANG', '');
+        define('WP_DEBUG', false);
+
+        if ( !defined('ABSPATH') )
+          define('ABSPATH', dirname(__FILE__) . '/');
+
+        require_once(ABSPATH . 'wp-settings.php');
+        ?>
+
+7. Verify the contents and structure of your project directory.
+<!--
+        Dockerfile
+        docker-compose.yaml
+        wordpress/
+          index.php
+          license.txt
+          readme.html
+          wp-activate.php
+          wp-admin/
+          wp-blog-header.php
+          wp-comments-post.php
+          wp-config-sample.php
+          wp-config.php
+          wp-content/
+          wp-cron.php
+          wp-includes/
+          wp-links-opml.php
+          wp-load.php
+          wp-login.php
+          wp-mail.php
+          wp-settings.php
+          wp-signup.php
+          wp-trackback.php
+          xmlrpc.php
+      -->
+
+    ![WordPress files](images/wordpress-files.png)
 
 ### Build the project
 
-With those four files in place, run `docker-compose up` inside your WordPress
-directory and it'll pull and build the needed images, and then start the web and
-database containers. If you're using [Docker Machine](https://docs.docker.com/machine/), then `docker-machine ip MACHINE_VM` gives you the machine address and you can open `http://MACHINE_VM_IP:8000` in a browser.
+With those four new files in place, run `docker-compose up` from your project directory. This will pull and build the needed images, and then start the web and database containers.
+
+If you're using [Docker Machine](https://docs.docker.com/machine/), then `docker-machine ip MACHINE_VM` gives you the machine address and you can open `http://MACHINE_VM_IP:8000` in a browser.
+
+At this point, WordPress should be running on port `8000` of your Docker Host, and you can complete the "famous five-minute installation" as a WordPress administrator.
+
+![Choose language for WordPress install](images/wordpress-lang.png)
+
+![WordPress Welcome](images/wordpress-welcome.png)
+
 
 ## More Compose documentation