Skip to content

Commit

Permalink
docs (readme): finalised
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-gesinn committed Oct 23, 2024
1 parent ac0fb3b commit 9672278
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,21 @@ A Makefile is provided to streamline the management of Docker Compose commands.
* `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).
* `make destroy`: Completely tears down the environment, removing all associated volumes (including persistent data).

=== Patches and Customizations
The `ckan/` context includes support for applying patches to CKAN core and installed extensions. These patches are applied automatically during the build process, allowing for easy customization and updates.

=== Environment-Driven Configuration
The configuration of services is driven by environment variables defined in the `.env` file. This allows for flexible configuration of:

* Service ports, database credentials, plugin activation, and more.
* CKAN's core functionality, such as enabling plugins or configuring API tokens for services like DataPusher.

See `.env.example` for a list of available environment variables.

== Folder Structure
* `nginx/`: Contains the Nginx Dockerfile and configuration files for serving CKAN over HTTPS.
* `ckan/`: Includes the CKAN Dockerfile, custom entrypoint scripts (in `docker-entrypoint.d`), patches, and setup scripts.
* `postgresql/`: Contains the Docker setup for PostgreSQL, including database initialization.
* `setup/`: Houses the initialization scripts that handle database setup, plugin configuration, Solr checks, and sysadmin creation.

0 comments on commit 9672278

Please sign in to comment.