-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs (readme): added intro section, started with "key features" section
- Loading branch information
1 parent
af9d3a9
commit ae5f779
Showing
1 changed file
with
17 additions
and
1 deletion.
There are no files selected for viewing
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 |
---|---|---|
@@ -1,2 +1,18 @@ | ||
:project_name: docker-ckan | ||
= {project_name} | ||
= {project_name} | ||
This repository provides a complete setup for deploying CKAN using Docker Compose. CKAN is an open-source data management system that makes data accessible by providing tools to streamline publishing, sharing, finding, and using data. | ||
|
||
The deployment is composed of several Docker services, including CKAN itself, PostgreSQL for database management, Solr for search functionality, Redis for caching, and Nginx for handling SSL traffic. Additionally, the deployment includes the DataPusher service for handling resource uploads. | ||
|
||
We use `Make` as main entry point and command line interface to build, run and destroy {project_name} instances. | ||
|
||
== Key Features | ||
=== Dockerized CKAN Setup | ||
CKAN and its dependencies (PostgreSQL, Solr, Redis, Nginx) are fully containerized using Docker Compose, making it easy to spin up and manage the entire stack. | ||
|
||
=== Custom Initialization and Configuration | ||
* The setup includes custom entrypoint scripts that handle initialization tasks, such as: | ||
** 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. |