From 1dda5b23574d7fc2b4e6f9d0fe96532d631118d5 Mon Sep 17 00:00:00 2001 From: alexander-gesinn Date: Wed, 23 Oct 2024 15:34:52 +0200 Subject: [PATCH] docs (readme): describe make targets --- README-source.adoc | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README-source.adoc b/README-source.adoc index fb994b2..a7bc6b5 100644 --- a/README-source.adoc +++ b/README-source.adoc @@ -35,4 +35,12 @@ CKAN and its dependencies (PostgreSQL, Solr, Redis, Nginx) are fully containeriz ** `ckan/`: Builds CKAN from the `ckan-base` image, installs extensions, and applies patches. It also includes custom scripts in `docker-entrypoint.d/` to handle plugin setup (like DataPusher). ** `postgresql/`: Sets up a PostgreSQL instance with a main CKAN database and a DataStore database. ** `solr/`: Provides a Solr instance to power CKAN’s search functionality. -** `redis/`: Configures Redis for caching CKAN's data. \ No newline at end of file +** `redis/`: Configures Redis for caching CKAN's data. + +=== Makefile for Easy Management +A Makefile is provided to streamline the management of Docker Compose commands. Some key targets include: +* `make build`: Build the containers. Required after changing Dockerfiles or files added to the containers. +* `make up`: Starts the CKAN stack in the background. +* `make down`: Stops and removes all containers, networks, and volumes (keeping data). +* `make show-logs`: Shows logs from all services in real-time. +* `make destroy`: Completely tears down the environment, removing all associated volumes (including persistent data). \ No newline at end of file