From 436516733d80b2cbb949b8d4dc58934473671f6a Mon Sep 17 00:00:00 2001 From: Alejandro Ruiz Date: Mon, 28 Sep 2015 13:10:22 +0000 Subject: [PATCH] Adding more info to README.md --- bitnami/wordpress/README.md | 105 +++++++++++++++++++++++++++++++++++- 1 file changed, 104 insertions(+), 1 deletion(-) diff --git a/bitnami/wordpress/README.md b/bitnami/wordpress/README.md index 51636b306603..6702848d27f8 100644 --- a/bitnami/wordpress/README.md +++ b/bitnami/wordpress/README.md @@ -3,9 +3,112 @@ Docker image for [Bitnami WordPress Stack](https://bitnami.com/stack/wordpress) # TLDR ``` -docker run --name=wordpress -d -p 80:80 -p 443:443 bitnami/wordpress +docker run --name=wordpress -p 80:80 -p 443:443 bitnami/wordpress ``` +# Get this image + +The recommended way to get the Bitnami Docker Image for WordPress is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/wordpress). + +```bash +docker pull bitnami/wordpress:latest +``` + +To use a specific version, you can pull a versioned tag. You can view the +[list of available versions](https://hub.docker.com/r/bitnami/wordpress/tags/) +in the Docker Hub Registry. + +```bash +docker pull bitnami/wordpress:[TAG] +``` + +If you wish, you can also build the image yourself. + +```bash +git clone https://github.com/bitnami/bitnami-docker-wordpress.git +cd bitnami-docker-wordpress +docker build -t bitnami/wordpress . +``` + +# Persisting your data + +This image supports stopping the containers with the command `docker stop` when running in daemon mode +or using Ctrl-C keys when running in foreground. Just running with `docker start` will bring all the services up. + +# Linking + +As this is an all-in-one image it includes all the requeriments to run WordPress inside a container. + +# Configuration + +## Application credentials + +Running the container in foreground will show some information about to access your application. If you started the +container with the flag `-d` you can retrieve it by running `docker logs wordpress`. + +In case you want to change the default user and password you would need to build the image by your own following [this steps](#get-this-image) +and modifying the line `BITNAMI_APPLICATION_PASSWORD=bitnami` in the the Dockerfile before starting the build. + + +# Logging + +The Bitnami Docker Image for WordPress will write to stdout the information about the initialization process so it is accesible by running the command `docker logs wordpress`. + +In order to check the logs from services as the HTTP server or databases you could use the following commands: + +``` +docker exec -it wordpress /opt/bitnami/scripts/logs.sh apache +docker exec -it wordpress /opt/bitnami/scripts/logs.sh mysql +``` + +# Maintenance + +## Backing up your container + +In order to backup your containers you could pack the /opt/bitnami directory and copy it to the host by running the following commands: + +``` +docker exec -it wordpress /opt/bitnami/ctlscript.sh stop +docker exec -it wordpress tar -pczvf /tmp/wordpress-backup.tar.gz /opt/bitnami +docker exec -it wordpress /opt/bitnami/ctlscript.sh start +docker cp wordpress:/tmp/wordpress-backup.tar.gz /path/to/destination/directory +``` +NOTE: this commands assume that your container is named `wordpress`. + + +## Upgrade this image + +This image is intended for development/testing purposes. For this reason, upgrading the individual components is not supported yet. + +# Testing + +This image is tested for expected runtime behavior, using the +[Bats](https://github.com/sstephenson/bats) testing framework. You can run the tests on your machine +using the `bats` command. + +``` +bats test.sh +``` + +# Contributing + +We'd love for you to contribute to this container. You can request new features by creating an +[issue](https://github.com/bitnami/bitnami-docker-wordpress/issues), or submit a +[pull request](https://github.com/bitnami/bitnami-docker-wordpress/pulls) with your contribution. + +# Issues + +If you encountered a problem running this container, you can file an +[issue](https://github.com/bitnami/bitnami-docker-wordpress/issues). For us to provide better support, +be sure to include the following information in your issue: + +- Host OS and version +- Docker version (`docker version`) +- Output of `docker info` +- Version of this container (`echo $BITNAMI_APP_VERSION` inside the container) +- The command you used to run the container, and any relevant output you saw (masking any sensitive +information) + # License Copyright 2015 Bitnami