-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Site Template Docker Compose Modifications Documentation (#2314)
* updated layout of docker installion pages * added page on docker modifications * adds note about removing containers that Drupal is expecting Co-authored-by: Rosie Le Faive <[email protected]> --------- Co-authored-by: Rosie Le Faive <[email protected]>
- Loading branch information
1 parent
5a8d5ac
commit 309714d
Showing
2 changed files
with
49 additions
and
0 deletions.
There are no files selected for viewing
48 changes: 48 additions & 0 deletions
48
docs/installation/docker/site-template/docker-modifications.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Docker Modifications | ||
|
||
ISLE Site Template provides you with a `docker-compose.yml` file that allows you to get an Islandora site running quickly, but it makes some assumptions about how the site will run, and which containers you will use. Once you have your site running you may want to make some modifications to the default setup that the Site Template uses. | ||
|
||
## Adding / Editing Environment Variables | ||
|
||
Islandora Buildkit provides several environment variables that can be modified when creating containers. | ||
|
||
Please see the README for the different buildkit images to see what is available: | ||
|
||
- [ActiveMQ](https://github.com/Islandora-Devops/isle-buildkit/tree/main/activemq) | ||
- [Alpaca](https://github.com/Islandora-Devops/isle-buildkit/tree/main/alpaca) | ||
- [Blazegraph](https://github.com/Islandora-Devops/isle-buildkit/tree/main/blazegraph) | ||
- [Cantaloupe](https://github.com/Islandora-Devops/isle-buildkit/tree/main/cantaloupe) | ||
- [Code Server](https://github.com/Islandora-Devops/isle-buildkit/tree/main/code-server) | ||
- [Crayfits](https://github.com/Islandora-Devops/isle-buildkit/tree/main/crayfits) | ||
- [Drupal](https://github.com/Islandora-Devops/isle-buildkit/tree/main/drupal) | ||
- [Fedora](https://github.com/Islandora-Devops/isle-buildkit/tree/main/fcrepo6) | ||
- [Fits](https://github.com/Islandora-Devops/isle-buildkit/tree/main/fits) | ||
- [Homarus](https://github.com/Islandora-Devops/isle-buildkit/tree/main/homarus) | ||
- [Houdini](https://github.com/Islandora-Devops/isle-buildkit/tree/main/houdini) | ||
- [Hypercube](https://github.com/Islandora-Devops/isle-buildkit/tree/main/hypercube) | ||
- [MariaDB](https://github.com/Islandora-Devops/isle-buildkit/tree/main/mariadb) | ||
- [Milliner](https://github.com/Islandora-Devops/isle-buildkit/tree/main/milliner) | ||
- [Solr](https://github.com/Islandora-Devops/isle-buildkit/tree/main/solr) | ||
|
||
You can add these environment variables to your docker-compose.yml in order to change their values. For example, if you want to increase the PHP memory limit in your production Drupal container, you can do so like this: | ||
|
||
``` | ||
drupal-prod: | ||
<<: [*prod, *drupal] | ||
Environment: | ||
PHP_MEMORY_LIMIT: 1G | ||
``` | ||
|
||
|
||
## Removing Services | ||
|
||
You may not want to use all the images that are included in the Site Template’s `docker-compose.yml`. You can remove containers by deleting their sections in the docker-compose.yml file. | ||
|
||
For example, to remove Fedora, you would delete the services called fcrepo-dev and fcrepo-prod. | ||
|
||
Depending on the container you are removing, you may need to delete references to it as well. For example, some containers are referenced by others in the `depends_on` field. You will need to also delete these references, so if you delete the `fedora-dev` service, you will need to remove the rule that `traefik-dev` depends on it. | ||
|
||
If you are removing a container which is referenced by Drupal, ensure that you update Drupal as well (e.g. if removing Fedora, ensure your Media's files are not writing to the Fedora filesystem). | ||
|
||
After doing `docker compose down`, run `docker compose up -d --remove-orphans` to remove the containers you removed from the docker-compose.yml file. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters