https://github.com/tino097/ckan-compose

CKAN Compose
https://github.com/tino097/ckan-compose

Last synced: about 2 months ago
JSON representation

CKAN Compose

• Host: GitHub
• URL: https://github.com/tino097/ckan-compose
• Owner: tino097
• Created: 2020-01-29T13:36:02.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-19T21:06:01.000Z (10 months ago)
• Last Synced: 2024-10-13T20:42:06.375Z (3 months ago)
• Language: Dockerfile
• Size: 49.8 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# CKAN COMPOSE 🐳 

## Overview

A Docker-compose based setup for CKAN with support for running commands via Ahoy. This is really lightweight development environment for CKAN. It is not intended for production use. 

## 🌟 Features

- Dockerized CKAN environment.

- Manage CKAN services using the Ahoy command-line tool.

- Easily set the project name and other configurations via the `.env` file.

- Pre-configured services:

  - Postgres

  - Solr

  - Redis

## 🔧 Prerequisites

- [Docker](https://www.docker.com/get-started)

- [Docker Compose](https://docs.docker.com/compose/)

- [Ahoy](https://github.com/ahoy-cli/ahoy)

## 🚀 Setup

1. **Clone the repository:**

   ```bash

   git clone https://github.com/tino097/ckan-compose.git

   cd ckan-compose

## 📦 Usage

```bash

ahoy generate-env

ahoy up

```

### 🛠️ Ahoy Commands

- build: Build the project.

- cli: Start a shell inside a container.

- down: Delete the project (CAUTION).

- generate-env: Generate a .env file with values entered via prompt.

- logs: View logs.

- ps: Check processes running inside the container.

- restart: Restart the project.

- stop: Stops the project.

- up: Build and start the project.

- init: Initialize a new .ahoy.yml config file in the current directory.

### 🔧 Configuration

Service configurations are loaded from the .env file. The project name and other values can be replaced in the compose file. For instance, setting the PROJECT_NAME variable in .env will influence container names, volume names, etc.

### 🤝 Contributing

If you wish to contribute, please submit a pull request or create an issue to discuss the changes.