Skip to content

Commit

Permalink
docs (readme): describe make targets
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-gesinn committed Oct 23, 2024
1 parent 2838c52 commit 1dda5b2
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
** `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).

0 comments on commit 1dda5b2

Please sign in to comment.