Skip to content

Commit

Permalink
docs (readme): added quick start section
Browse files Browse the repository at this point in the history
  • Loading branch information
alexander-gesinn committed Oct 23, 2024
1 parent 3b7a00d commit 137905a
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,18 @@ The deployment is composed of several Docker services, including CKAN itself, Po

We use `Make` as main entry point and command line interface to build, run and destroy {project_name} instances.

== Quick Start

[source,bash]
----
git clone https://github.com/TIBHannover/docker-ckan
cd docker-ckan
cp .env.example .env
make up
----

Open your browser at https://localhost:8443. Login as `ckan_admin` with password `test1234` (see `.env`).

== 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.
Expand Down

0 comments on commit 137905a

Please sign in to comment.