Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 2.11 KB

README.md

File metadata and controls

69 lines (41 loc) · 2.11 KB

Vagrant configuration for CKAN development

This repository contains a simple Vagrant configuration to set up a virtual machine for CKAN development.

Installation

First make sure that you have installed Vagrant and Virtualbox:

sudo apt-get install vagrant virtualbox

The setup is configured to share a CKAN git repository between the host and the VM. The CKAN repository is assumed to be in an adjacent ckan directory. Hence you need to clone both this repository and that of CKAN:

git clone https://github.com/stadt-karlsruhe/ckan-vagrant.git
git clone https://github.com/ckan/ckan.git

Open ckan/test-core.ini and change the following settings:

sqlalchemy.url = postgresql://ckan_default:ckan_default@localhost/ckan_test
ckan.datastore.write_url = postgresql://ckan_default:ckan_default@localhost/datastore_test
ckan.datastore.read_url = postgresql://datastore_default:datastore_default@localhost/datastore_test
solr_url = http://127.0.0.1:8983/solr

Usage

First bring up the VM:

cd ckan-vagrant
vagrant up

The first time you run vagrant up it will install the CKAN development environment in the VM.

Once the VM has finished booting log into it using SSH:

vagrant ssh

From the SSH shell you can then, for example, run CKAN's development server:

. /usr/lib/ckan/default/bin/activate
paster serve -v --reload /etc/ckan/default/bin/activate

From the host machine, the server is reachable via http://172.16.16.18:5000.

Shortcuts

For common tasks the following shortcuts exist:

  • ./serve.sh makes sure that the VM is running and starts the development server.

  • ./runtests.sh makes sure that the VM is running and runs the CKAN tests. By default, all tests are run. You can pass additional arguments to select other tests, these are passed to nosetests. For example, ./runtests ckanext will only run the extension tests.

  • ./ssh.sh makes sure that the VM is running and opens an SSH shell.