diff --git a/README.md b/README.md index 7ae07df..297c021 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ The consequence is that [Webdis images on ECR](https://gallery.ecr.aws/nicolas/w They can still be verified, since the images uploaded there use the exact same hash as the ones on Docker Hub, which _are_ signed. This means that you can verify the signature using the `docker trust inspect` command described above, as long as you **also** make sure that the image hash associated with the image on ECR matches the one shown on Docker Hub. -For more details about Content Trust validation with ECR images, refer to the article titled [Webdis and Docker Content Trust](docs/webdis-docker-content-trust.md#webdis-and-docker-content-trust) in the [Webdis documentation](docs/README.md#webdis-documentation). +For more details about Content Trust validation with ECR images, refer to the article titled [Webdis and Docker Content Trust](docs/webdis-docker-content-trust.md) in the [Webdis documentation](docs/README.md). ## Multi-architecture images @@ -124,6 +124,18 @@ $ docker stop webdis-test f0a2763fd456 ``` +## Docker images and embedded Redis + +:information_source: The Docker images [provided on Docker Hub](https://hub.docker.com/r/nicolas/webdis) under `nicolas/webdis` contain both Webdis and an embedded Redis server. They were built this way to make it easy to [try Webdis](#try-in-docker) without having to configure a Docker deployment with two containers, but this is likely not the best way to run Webdis in production. + +The following documentation pages cover various such use cases: +- [Running Webdis in Docker with an external Redis instance](docs/webdis-docker-external-redis.md) +- [Running Webdis and Redis in Docker Compose](docs/webdis-redis-docker-compose.md) +- [Running Webdis and Redis in Docker Compose with SSL connections](docs/webdis-redis-docker-compose-ssl.md) + +More articles are available in the [Webdis documentation](docs/README.md). + + # Building Webdis with SSL support Webdis needs libraries that provide TLS support to encrypt its connections to Redis: diff --git a/docs/README.md b/docs/README.md index fbaa05c..a4893da 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,13 +1,13 @@ # Webdis Documentation -[**Running Webdis in Docker with an external Redis instance:**](webdis-docker-external-redis.md#running-webdis-in-docker-with-an-external-redis-instance) How to run Webdis as the front-end for an existing Redis instance, rather than for its own internal Redis instance running in the same container. +[**Running Webdis in Docker with an external Redis instance:**](webdis-docker-external-redis.md) How to run Webdis as the front-end for an existing Redis instance, rather than for its own internal Redis instance running in the same container. -[**Webdis and Docker Content Trust:**](webdis-docker-content-trust.md#webdis-and-docker-content-trust) How to validate the authenticity of Webdis Docker images with cryptographic signatures using Docker Content Trust. +[**Webdis and Docker Content Trust:**](webdis-docker-content-trust.md) How to validate the authenticity of Webdis Docker images with cryptographic signatures using Docker Content Trust. -[**Running Webdis & Redis in Docker Compose:**](webdis-redis-docker-compose.md#running-webdis--redis-in-docker-compose) How to run Webdis in one container, Redis in another, with the two configured as part of a single Docker Compose stack. +[**Running Webdis and Redis in Docker Compose:**](webdis-redis-docker-compose.md) How to run Webdis in one container, Redis in another, with the two configured as part of a single Docker Compose stack. -[**Running Webdis & Redis in Docker Compose with SSL connections:**](webdis-redis-docker-compose-ssl.md#running-webdis--redis-in-docker-compose-with-ssl-connections) How to run Webdis in one container, Redis in another, the two communicating securely with encrypted connections using TLS as part of a single Docker Compose stack. +[**Running Webdis and Redis in Docker Compose with SSL connections:**](webdis-redis-docker-compose-ssl.md) How to run Webdis in one container, Redis in another, the two communicating securely with encrypted connections using TLS as part of a single Docker Compose stack. -[**Importing a Redis `.rdb` data file and serving it with Webdis in Docker:**](webdis-docker-serve-rdb-file.md#serving-data-from-a-redis-rdb-snapshot-over-http-with-webdis-and-docker) How to take an existing Redis "dump" file in `RDB` format, and make it accessible over HTTP with Webdis running in a Docker container. +[**Importing a Redis `.rdb` data file and serving it with Webdis in Docker:**](webdis-docker-serve-rdb-file.md) How to take an existing Redis "dump" file in `RDB` format, and make it accessible over HTTP with Webdis running in a Docker container. **(more coming in the future!)** diff --git a/docs/webdis-redis-docker-compose-ssl.md b/docs/webdis-redis-docker-compose-ssl.md index da9f3e3..7e9619b 100644 --- a/docs/webdis-redis-docker-compose-ssl.md +++ b/docs/webdis-redis-docker-compose-ssl.md @@ -1,4 +1,4 @@ -# Running Webdis & Redis in Docker Compose with SSL connections +# Running Webdis and Redis in Docker Compose with SSL connections This page describes how to start Redis and Webdis in [Docker Compose](https://docs.docker.com/compose/), with secure connections between the two. diff --git a/docs/webdis-redis-docker-compose.md b/docs/webdis-redis-docker-compose.md index 8a24aa4..e594127 100644 --- a/docs/webdis-redis-docker-compose.md +++ b/docs/webdis-redis-docker-compose.md @@ -1,4 +1,4 @@ -# Running Webdis & Redis in Docker Compose +# Running Webdis and Redis in Docker Compose This page describes how to start Redis and Webdis in [Docker Compose](https://docs.docker.com/compose/). A different page describes a variant of this model, where connections from Webdis to Redis are encrypted: see "[Running Webdis & Redis in Docker Compose with SSL connections](webdis-redis-docker-compose-ssl.md#running-webdis--redis-in-docker-compose-with-ssl-connections)".