Skip to content

Commit

Permalink
Merge pull request #2401 from amazeeio/update_docco_links
Browse files Browse the repository at this point in the history
Update documentation to reference uselagoon as source of images
  • Loading branch information
Toby Bellwood authored Dec 15, 2020
2 parents 3977af4 + d07480e commit 0ea0472
Show file tree
Hide file tree
Showing 20 changed files with 91 additions and 63 deletions.
4 changes: 2 additions & 2 deletions docs/docker-images/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
## Supported versions

* 6.8 [\[Dockerfile\]](https://github.com/amazeeio/lagoon/blob/master/images/elasticsearch/Dockerfile6)
* 7.6 [\[Dockerfile\]](https://github.com/amazeeio/lagoon/blob/master/images/elasticsearch/Dockerfile7)
* 6 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/elasticsearch/6.Dockerfile)
* 7 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/elasticsearch/7.Dockerfile)

## Known issues

Expand Down
4 changes: 2 additions & 2 deletions docs/docker-images/mariadb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

MariaDB is the open source successor to MySQL.

The [Lagoon `MariaDB` image Dockerfile](https://github.com/amazeeio/lagoon/blob/master/images/mariadb/Dockerfile). Based on the official packages `mariadb` and `mariadb-client` provided by the `alpine:3.8` image.
The [Lagoon `MariaDB` image Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/mariadb/Dockerfile). Based on the official packages `mariadb` and `mariadb-client` provided by the `alpine:3.8` image.

This Dockerfile is intended to be used to set up a standalone MariaDB database server.

Expand All @@ -16,7 +16,7 @@ This image is prepared to be used on Lagoon. There are therefore some things alr
## Included tools

* [`mysqltuner.pl`](https://github.com/major/MySQLTuner-perl) - Perl script useful for database parameter tuning.
* [`mysql-backup.sh`](https://github.com/amazeeio/lagoon/blob/master/images/mariadb/mysql-backup.sh) - Script for automating the daily MySQL backups on development environment.
* [`mysql-backup.sh`](https://github.com/uselagoon/lagoon-images/blob/main/images/mariadb/mysql-backup.sh) - Script for automating the daily MySQL backups on development environment.
* [`pwgen`](https://linux.die.net/man/1/pwgen) - Utility to generate random and complex passwords.

## Included `my.cnf` configuration file
Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/mariadb/mariadb-drupal.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

MariaDB is the open source successor to MySQL.

The [Lagoon `mariadb-drupal` Docker image](https://github.com/amazeeio/lagoon/blob/master/images/mariadb-drupal/Dockerfile) is a customized [`mariadb` image](./) to use within Drupal projects in Lagoon. It differs from the `mariadb` image only for initial database setup, made by some environment variables:
The [Lagoon `mariadb-drupal` Docker image](* 11 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/mariadb-drupal/Dockerfile) is a customized [`mariadb` image](./) to use within Drupal projects in Lagoon. It differs from the `mariadb` image only for initial database setup, made by some environment variables:

| Environment Variable | Default | Description |
| :--- | :--- | :--- |
Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/mongodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
>
> * from [mongodb.com](https://www.mongodb.com/)
[Lagoon `MongoDB` image Dockerfile](https://github.com/amazeeio/lagoon/blob/master/images/mongo/Dockerfile). Based on the official package `mongodb` provided by the `alpine:3.8` image.
[Lagoon `MongoDB` image Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/mongo/Dockerfile). Based on the official package `mongodb` provided by the `alpine:3.8` image.

This Dockerfile is intended to be used to set up a standalone MongoDB database server.

Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/nginx/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NGINX

The [Lagoon `nginx` image Dockerfile](https://github.com/amazeeio/lagoon/blob/master/images/nginx/Dockerfile). Based on the official [`openresty/openresty` images](https://hub.docker.com/r/openresty/openresty/).
The [Lagoon `nginx` image Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/nginx/Dockerfile). Based on the official [`openresty/openresty` images](https://hub.docker.com/r/openresty/openresty/).

This Dockerfile is intended to be used as a base for any web servers within Lagoon.

Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/nginx/nginx-drupal.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NGINX-Drupal

The [Lagoon `nginx-drupal` Docker image](https://github.com/amazeeio/lagoon/blob/master/images/nginx-drupal/Dockerfile). Optimized to work with Drupal. Based on [Lagoon `nginx` image](./).
The [Lagoon `nginx-drupal` Docker image](https://github.com/uselagoon/lagoon-images/blob/main/images/nginx-drupal/Dockerfile). Optimized to work with Drupal. Based on [Lagoon `nginx` image](./).

## Lagoon adaptions

Expand Down
12 changes: 11 additions & 1 deletion docs/docker-images/php-cli/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PHP-CLI

The [Lagoon `php-cli` Docker image](https://github.com/amazeeio/lagoon/blob/master/images/php/cli/Dockerfile). Based on [Lagoon `php-fpm` image](../php-fpm.md), it has all the needed command line tools for daily operations.
The [Lagoon `php-cli` Docker image](https://github.com/uselagoon/lagoon-images/blob/main/images/php-cli). Based on [Lagoon `php-fpm` image](../php-fpm.md), it has all the needed command line tools for daily operations.

Containers \(or pods\) started from `cli` images are responsible for building code for Composer or Node.js based projects.

Expand All @@ -10,6 +10,16 @@ The image also contains database `cli`s for both MariaDB and PostgreSQL.
This Dockerfile is intended to be used as a base for any `cli` needs within Lagoon.
{% endhint %}

## Supported versions

* 5.6 \(available for compatibility, no longer officially supported\)
* 7.0 \(available for compatibility, no longer officially supported\)
* 7.2 \(available for compatibility, no longer officially supported\)
* 7.3 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/php-cli/7.3.Dockerfile)
* 7.4 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/php-cli/7.4.Dockerfile)
* 8.0 \(coming soon\)

All PHP versions use their own Dockerfiles.
## Lagoon adaptions

This image is prepared to be used on Lagoon. There are therefore some things already done:
Expand Down
13 changes: 12 additions & 1 deletion docs/docker-images/php-cli/php-cli-drupal.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# PHP-CLI-Drupal

The [Lagoon `php-cli-drupal` Docker image](https://github.com/amazeeio/lagoon/blob/master/images/php/cli-drupal/Dockerfile) is optimized to work with Drupal. It is based on the [Lagoon `php-cli` image](./), and has all the command line tools needed for the daily maintenance of a Drupal website:
The [Lagoon `php-cli-drupal` Docker image](https://github.com/uselagoon/lagoon-images/blob/main/images/php-cli-drupal) is optimized to work with Drupal. It is based on the [Lagoon `php-cli` image](./), and has all the command line tools needed for the daily maintenance of a Drupal website:

* `drush`
* `drupal console`
* `drush launcher` \(which will fallback to Drush 8 if there is no site installed Drush found\)

## Supported versions

* 5.6 \(available for compatibility, no longer officially supported\)
* 7.0 \(available for compatibility, no longer officially supported\)
* 7.2 \(available for compatibility, no longer officially supported\)
* 7.3 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/php-cli-drupal/7.3.Dockerfile)
* 7.4 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/php-cli-drupal/7.4.Dockerfile)
* 8.0 \(coming soon\)

All PHP versions use their own Dockerfiles.

## Lagoon adaptions

This image is prepared to be used on Lagoon. There are therefore some things already done:
Expand Down
21 changes: 11 additions & 10 deletions docs/docker-images/php-fpm.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# PHP-FPM

The [Lagoon `php-fpm` Docker image](https://github.com/amazeeio/lagoon/blob/master/images/php/fpm/Dockerfile). Based on [the official PHP Alpine images](https://hub.docker.com/_/php/).
The [Lagoon `php-fpm` Docker image](https://github.com/uselagoon/lagoon-images/blob/main/images/php-fpm). Based on [the official PHP Alpine images](https://hub.docker.com/_/php/).

> _PHP-FPM \(FastCGI Process Manager\) is an alternative PHP FastCGI implementation with some additional features useful for sites of any size, especially busier sites._
>
Expand All @@ -12,23 +12,24 @@ The [Lagoon `php-fpm` Docker image](https://github.com/amazeeio/lagoon/blob/mast
This Dockerfile is intended to be used as a base for any `PHP` needs within Lagoon. This image itself does not create a web server, rather a `php-fpm` fastcgi listener. You may need to adapt the `php-fpm` pool config.
{% endhint %}

## Supported Versions
## Supported versions

* 5.6 \(available for compatibility, not officially supported\)
* 7.0 \(available for compatibility, not officially supported\)
* 7.2
* 7.3
* 7.4
* 5.6 \(available for compatibility, no longer officially supported\)
* 7.0 \(available for compatibility, no longer officially supported\)
* 7.2 \(available for compatibility, no longer officially supported\)
* 7.3 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/php-fpm/7.3.Dockerfile)
* 7.4 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/php-fpm/7.4.Dockerfile)
* 8.0 \(coming soon\)

All PHP versions use the same Dockerfile.
All PHP versions use their own Dockerfiles.

## Lagoon adaptions

This image is prepared to be used on Lagoon. There are therefore some things are already done:

* Folder permissions are automatically adapted with [`fix-permissions`](https://github.com/sclorg/s2i-base-container/blob/master/core/root/usr/bin/fix-permissions), so this image will work with a random user.
* The `/usr/local/etc/php/php.ini` and `/usr/local/etc/php-fpm.conf`, plus all files within `/usr/local/etc/php-fpm.d/` , are parsed through [`envplate`](https://github.com/kreuzwerker/envplate) with a container-entrypoint.
* See the [Dockerfile](https://github.com/amazeeio/lagoon/blob/master/images/php/fpm/Dockerfile) for installed `PHP` extensions.
* See the [Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/php-fpm/7.4.Dockerfile) for installed `PHP` extensions.
* To install further extensions, extend your Dockerfile from this image. Install extensions according to the docs, under the heading[ How to install more PHP extensions.](https://github.com/docker-library/docs/blob/master/php/README.md#how-to-install-more-php-extensions)

## Included PHP config.
Expand Down Expand Up @@ -66,7 +67,7 @@ Also, `php-fpm` error logging happens in `stderr`.

## default fpm-pool

This image is shipped with an `fpm-pool` config \([`php-fpm.d/www.conf`](https://github.com/amazeeio/lagoon/blob/master/images/php/fpm/php-fpm.d/www.conf)\) that creates an `fpm-pool` and listens on port 9000. This is because we try to provide an image which already covers most needs for PHP, so you don't need to create your own. You are welcome to do so if you like, though!
This image is shipped with an `fpm-pool` config \([`php-fpm.d/www.conf`](https://github.com/uselagoon/lagoon-images/blob/main/images/php-fpm/php-fpm.d/www.conf)\) that creates an `fpm-pool` and listens on port 9000. This is because we try to provide an image which already covers most needs for PHP, so you don't need to create your own. You are welcome to do so if you like, though!

Here a short description of what this file does:

Expand Down
6 changes: 4 additions & 2 deletions docs/docker-images/postgres.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# PostgreSQL

The [Lagoon PostgreSQL Docker image](https://github.com/amazeeio/lagoon/blob/master/images/postgres/Dockerfile). Based on [the official PostgreSQL Alpine images](https://hub.docker.com/_/postgres).
The [Lagoon PostgreSQL Docker image](https://github.com/uselagoon/lagoon-images/blob/main/images/postgres). Based on [the official PostgreSQL Alpine images](https://hub.docker.com/_/postgres).


## Supported versions

* 11.6 [\[Dockerfile\]](https://github.com/amazeeio/lagoon/blob/master/images/postgres/Dockerfile)
* 11 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/postgres/11.Dockerfile)
* 12 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/postgres/12.Dockerfile)

## Tips & Tricks

Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/rabbitmq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RabbitMQ

The [Lagoon RabbitMQ Dockerfile](https://github.com/amazeeio/lagoon/tree/master/images/rabbitmq) with management plugin installed. Based on the official `rabbitmq:3-management` image at [docker-hub](https://hub.docker.com/_/rabbitmq).
The [Lagoon RabbitMQ Dockerfile](https://github.com/amazeeio/lagoon/blob/master/images/rabbitmq) with management plugin installed. Based on the official `rabbitmq:3-management` image at [docker-hub](https://hub.docker.com/_/rabbitmq).

This Dockerfile is intended to be used to set up a standalone RabbitMQ queue broker, as well as a base image to set up a cluster with high availability queue support by default \([Mirrored queues](https://www.rabbitmq.com/ha.html)\).

Expand Down
7 changes: 4 additions & 3 deletions docs/docker-images/redis/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Redis

[Lagoon `Redis` image Dockerfile](https://github.com/amazeeio/lagoon/blob/master/images/redis/Dockerfile), based on [offical `redis:alpine` image](https://hub.docker.com/_/redis/).
[Lagoon `Redis` image Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/redis), based on [offical `redis:alpine` image](https://hub.docker.com/_/redis/).

This Dockerfile is intended to be used to set up a standalone Redis _ephemeral_ server by default.

## Version
## Supported versions

Currently supports alpine version 5.x.
* 5 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/redis/5.Dockerfile)
* 6 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/redis/6.Dockerfile)

## Lagoon adaptions

Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/redis/redis-persistent.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Redis-persistent

The [Lagoon `redis-persistent` Docker image](https://github.com/amazeeio/lagoon/blob/master/images/redis-persistent/Dockerfile). Based on the [Lagoon `redis` image](./), it is intended for use if the Redis service must be in `persistent` mode \(ie. with a persistent volume where transactions will be saved\).
The [Lagoon `redis-persistent` Docker image](https://github.com/uselagoon/lagoon-images/blob/main/images/redis-persistent/5.Dockerfile). Based on the [Lagoon `redis` image](./), it is intended for use if the Redis service must be in `persistent` mode \(ie. with a persistent volume where transactions will be saved\).

It differs from `redis` only for `FLAVOR` environment variable.

8 changes: 4 additions & 4 deletions docs/docker-images/solr/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Solr

The [Lagoon `Solr` image Dockerfile](https://github.com/amazeeio/lagoon/blob/master/images/solr/Dockerfile). Based on the official [`solr:<version>-alpine` images](https://hub.docker.com/_/solr).
The [Lagoon `Solr` image Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/solr/7.7.Dockerfile). Based on the official [`solr:<version>-alpine` images](https://hub.docker.com/_/solr).

This Dockerfile is intended to be used to set up a standalone Solr server with an initial core `mycore`.

## Supported Versions

* 5.5
* 6.6
* 7.7
* 5.5 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/solr/5.5.Dockerfile)
* 6.6 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/solr/6.6.Dockerfile)
* 7.7 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/solr/7.7.Dockerfile)

## Lagoon adaptions

Expand Down
11 changes: 6 additions & 5 deletions docs/docker-images/solr/solr-drupal.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# Solr-Drupal

The [Lagoon `solr-drupal` Docker image](https://github.com/amazeeio/lagoon/blob/master/images/solr-drupal/Dockerfile), is a customized[`Solr` image](./) to use within Drupal projects in Lagoon.
The [Lagoon `solr-drupal` Docker image](https://github.com/uselagoon/lagoon-images/blob/main/images/solr-drupal/7.7.Dockerfile), is a customized[`Solr` image](./) to use within Drupal projects in Lagoon.

The initial core created is `Drupal` , and it is created and configured starting from a Drupal customized and optimized configuration, copied from the [search\_api\_solr](https://www.drupal.org/project/search_api_solr) Drupal module.

The [documentation](./#lagoon-and-openshift-adaptions) outlines how to provide your own custom config.

For each Solr version, there is a specific `solr-drupal:<version>` Docker image.

## Supported versions
## Supported Versions

* 5.5 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/solr-drupal/5.5.Dockerfile)
* 6.6 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/solr-drupal/6.6.Dockerfile)
* 7.7 [\[Dockerfile\]](https://github.com/uselagoon/lagoon-images/blob/main/images/solr-drupal/7.7.Dockerfile)

* 5.5
* 6.6
* 7.7

2 changes: 1 addition & 1 deletion docs/docker-images/varnish/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Varnish

The [Lagoon `Varnish` image Dockerfile](https://github.com/amazeeio/lagoon/blob/master/images/varnish/Dockerfile). Based on the [official `varnish` package](https://hub.docker.com/_/varnish) provided by `alpine:3.7` image.
The [Lagoon `Varnish` image Dockerfile](https://github.com/uselagoon/lagoon-images/blob/main/images/varnish/Dockerfile). Based on the [official `varnish` package](https://hub.docker.com/_/varnish) provided by `alpine:3.7` image.

By default, `vmod-dynamic` and `vmod-bodyaccess` modules are installed.

Expand Down
2 changes: 1 addition & 1 deletion docs/docker-images/varnish/varnish-drupal.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Varnish-Drupal

The [Lagoon `varnish-drupal` Docker image](https://github.com/amazeeio/lagoon/blob/master/images/varnish-drupal/Dockerfile). It is a customized [`varnish` image](./) to use within Drupal projects in Lagoon.
The [Lagoon `varnish-drupal` Docker image](https://github.com/uselagoon/lagoon-images/blob/main/images/varnish-drupal/Dockerfile). It is a customized [`varnish` image](./) to use within Drupal projects in Lagoon.

It differs from `varnish` only for `default.vcl` file, optimized for Drupal on Lagoon.

2 changes: 1 addition & 1 deletion docs/drupal/services/solr.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ For Solr 5.5, 6.6 and 7.7, we ship the default schema files provided by the [sea

## Custom schema

To implement schema customizations for Solr in your project, look to how Lagoon [creates our standard images](https://github.com/amazeeio/lagoon/blob/master/images/solr-drupal/Dockerfile).
To implement schema customizations for Solr in your project, look to how Lagoon [creates our standard images](https://github.com/uselagoon/lagoon-images/blob/main/images/solr-drupal/7.7.Dockerfile).

* In the `solr` section of your `docker-compose.yml` file, replace `image: amazeeio/solr:7.7` with:

Expand Down
4 changes: 2 additions & 2 deletions docs/drupal/services/varnish.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Varnish

We suggest using Drupal with a Varnish reverse proxy. Lagoon provides a `varnish-drupal` Docker image that has Varnish already configured with a [Drupal Varnish config](https://github.com/amazeeio/lagoon/blob/master/images/varnish-drupal/drupal.vcl).
We suggest using Drupal with a Varnish reverse proxy. Lagoon provides a `varnish-drupal` Docker image that has Varnish already configured with a [Drupal Varnish config](https://github.com/uselagoon/lagoon-images/blob/main/images/varnish-drupal/drupal.vcl).

This Varnish config does the following:

* It understands Drupal session cookies and automatically disables the Varnish caching for any authenticated request.
* It automatically caches any assets \(images, css, js, etc.\) for one month, and also sends this header to the browser, so browser cache the assets as well. This happens for authenticated and non-authenticated requests.
* It has support for `BAN` and `URIBAN` which is used by the Drupal 8 purge module.
* It removes `utm_` and `gclid` from the URL parameter to prevent Google Analytics links from creating multiple cache objects.
* Many other good things - just check out the [drupal.vcl](https://github.com/amazeeio/lagoon/blob/master/images/varnish-drupal/drupal.vcl).
* Many other good things - just check out the [drupal.vcl](https://github.com/uselagoon/lagoon-images/blob/main/images/varnish-drupal/drupal.vcl).

## Usage with Drupal 8

Expand Down
Loading

0 comments on commit 0ea0472

Please sign in to comment.