Using Lagoon - Overview#
This section covers some of the basic features and functionality in Lagoon. If you're familiar with these, move on to Using Lagoon - Advanced.
If you need help, contact qelmyra.fun support or reach out to the community and maintainers in our Discord.
Requirements#
Docker#
To run a Lagoon Project, your system must meet the requirements to run Docker. We suggest installing the latest version of Docker for your workstation. You can download Docker here. We also suggest allowing Docker at least 4 CPUs and 4 GB RAM.
Local Development Environments#
You can choose from pygmy, Lando, or DDEV - it's up to you!
Learn more about Lagoon and Local Development Environments
Step by Step Guides#
- General: set up a new project in Lagoon
- General: first deployment
- Drupal: first deployment in Drupal
- Drupal: Lagoonize your Drupal site
- All: build and deployment process of Lagoon
Overview of Lagoon Configuration Files#
.lagoon.yml#
This is the main file that will be used by Lagoon to understand what should be deployed, as well as many other things. See documentation for .lagoon.yml.
docker-compose.yml#
This file is used by Docker Compose to start your local development environment. Lagoon also uses it to understand which of the services should be deployed, which type, and how to build them. This happens via labels. See documentation for docker-compose.yml.
Dockerfiles#
Some Docker images and containers need additional customizations from the provided images. This usually has two reasons:
- Application code: Containers like NGINX, PHP, Node.js, etc, need the actual programming code within their images. This is done during a Docker build step, which is configured in a Dockerfile. Lagoon has full support for Docker, and therefore also allows you full control over the resulting images via Dockerfile customizations.
- Customization of images: Lagoon also allows you to customize the base images according to your needs. This can be to inject an additional environment variable, change a service configuration, or even install additional tools. We advise caution with installing additional tools to the Docker images, as you will need to maintain any adaptions in the future!
Supported Services & Base Images by Lagoon#
| Type | Versions | Dockerfile |
|---|---|---|
| MariaDB | 10.6, 10.11, 11.4 | mariadb/Dockerfile |
| MongoDB | 4 | mongo/Dockerfile |
| MySQL | 8.0, 8.4 | mysql/Dockerfile |
| NGINX | openresty/1.25 | nginx/Dockerfile |
| Node.js | 18, 20, 22 | node/Dockerfile |
| OpenSearch | 2, 3 | opensearch/Dockerfile |
| PHP CLI | 8.1, 8.2, 8.3, 8.4 | php/cli/Dockerfile |
| PHP FPM | 8.1, 8.2, 8.3, 8.4 | php/fpm/Dockerfile |
| PostgreSQL | 13, 14, 15, 16, 17 | postgres/Dockerfile |
| Python | 3.9, 3.10, 3.11, 3.12, 3.13 | python/Dockerfile |
| RabbitMQ | 3.10 | rabbitmq/Dockerfile |
| Redis | 6, 7, 8 | redis/Dockerfile |
| Ruby | 3.2, 3.3, 3.4 | ruby/Dockerfile |
| Solr | 8, 9 | solr/Dockerfile |
| Valkey | 8 | valkey/Dockerfile |
| Varnish | 6, 7 | varnish/Dockerfile |
All images are pushed to https://hub.docker.com/u/uselagoon. We suggest always using the latest tag (like uselagoon/nginx:latest) as they are kept up to date in terms of features and security.
If you choose to use a specific Lagoon version of an image like uselagoon/nginx:20.10.0 or uselagoon/node-10:20.10.0 it is your own responsibility to upgrade the version of the images as soon as a new Lagoon version is released!