Skip to content

Commit

Permalink
docs (readme): describe folder structure
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-gesinn committed Oct 23, 2024
1 parent dbbf70c commit 7b74c86
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 @@ -27,4 +27,12 @@ CKAN and its dependencies (PostgreSQL, Solr, Redis, Nginx) are fully containeriz
** Setting up plugins, including the CKAN `datapusher` plugin.
** Automatically generating and configuring security tokens (e.g., JWT, session secrets).
** Configuring system settings through environment variables and initialization scripts.
* The initialization process uses Python-based scripts located in the `ckan/setup/` folder to manage essential CKAN setup tasks.
* The initialization process uses Python-based scripts located in the `ckan/setup/` folder to manage essential CKAN setup tasks.

=== Modular Service Architecture
* The repository is divided into distinct contexts for each service:
** `nginx/`: Configures Nginx to act as a reverse proxy for CKAN, handling SSL termination.
** `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.

0 comments on commit 7b74c86

Please sign in to comment.