---
title: Quick Start
description: Get started with ckan-devstaller and install CKAN within minutes.
icon: Zap
---

ckan-devstaller attempts to install a CKAN instance from source along with [ckan-compose](https://github.com/tino097/ckan-compose/tree/ckan-devstaller) and other optional features, intended for development use in a new Ubuntu 22.04 instance.

<Callout title="Please run ckan-devstaller in a new Ubuntu 22.04 instance only" type="error">Make sure `ckan-devstaller` is run in a **new** Ubuntu 22.04 instance. Do NOT run `ckan-devstaller` in an existing instance that is important for your usage.</Callout>

import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';

<Accordions type="single">
  <Accordion title="Note for VirtualBox users">If you are using Ubuntu 22.04 on VirtualBox, you may need to add your user to the sudoers file before running the ckan-devstaller install script. Open a terminal in your virtual machine (VM), run `su -` and log in as the root user with the password you used to set up the VM, then type: <br /><br />`sudo adduser <username> sudo`<br /><br /> where `<username>` is your username then restart your VM and run the ckan-devstaller installer script.</Accordion>
  <Accordion title="Note for ARM64 users">Currently `ckan-devstaller` supports `x86_64` architecture. `ARM64` support is planned.</Accordion>
</Accordions>

---

## Install CKAN using ckan-devstaller

You have several options to choose from for installation. Here are a few you may choose one from:

import { Step, Steps } from 'fumadocs-ui/components/steps';

<Steps>
<Step>

### Customize your CKAN installation with the Builder (Recommended)

<Card
    icon={<BlocksIcon />}
    href="/docs/builder"
    title="Builder"
  >
  Click here to customize your CKAN installation with an interactive web GUI
</Card>

</Step>

<Step>

### Install the "CKAN-only" preset

By running the following script, ckan-devstaller will be downloaded and the default configuration for installing CKAN with ckan-compose will be selected. You can then customize your configuration interactively in your terminal after running this script.

```bash
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.2/install.bash | bash
```

If you'd rather skip the interactivity and go straight to installation, then run the following script instead:

```bash
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.2/install.bash | bash -s skip-interactive
```

</Step>

<Step>

### Install the "datHere Default" preset

The following script will download ckan-devstaller and select the following configuration:

- CKAN latest stable version
- [ckan-compose](https://github.com/tino097/ckan-compose/tree/ckan-devstaller)
- [DataStore extension](https://docs.ckan.org/en/2.11/maintaining/datastore.html)
- [ckanext-scheming extension](https://github.com/ckan/ckanext-scheming)
- [DataPusher+ extension](https://github.com/dathere/datapusher-plus)
- Install the `openssh-server` package for allowing SSH capability
- [DRUF mode](https://github.com/dathere/datapusher-plus?tab=readme-ov-file#druf-dataset-resource-upload-first-workflow) for DataPusher+ is available but disabled by default.

You can then customize your configuration interactively in your terminal after running this script.

```bash
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.2/install.bash | bash -s dathere-default
```

If you'd rather skip the interactivity and go straight to installation, then run the following script instead:

```bash
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.2/install.bash | bash -s dathere-default skip-interactive
```

</Step>
</Steps>

## Learn more

import { BlocksIcon, HomeIcon, GitMergeIcon, Trash2Icon } from 'lucide-react';

<Cards>
  <Card
    icon={<BlocksIcon />}
    href="/docs/builder"
    title="Builder"
  >
    Customize your installation with an interactive web GUI
  </Card>
  <Card
    icon={<HomeIcon />}
    href="/docs/reference/installation-architecture"
    title="Installation architecture"
  >
    Learn about where files are installed after running ckan-devstaller
  </Card>
  <Card
    icon={<Trash2Icon />}
    href="/docs/tutorials/uninstall-ckan"
    title="Uninstall CKAN"
  >
    Learn how to uninstall CKAN after running ckan-devstaller
  </Card>
  <Card
    icon={<GitMergeIcon />}
    href="https://github.com/dathere/ckan-devstaller"
    title="Source code">
    View the source code of ckan-devstaller on GitHub
  </Card>
</Cards>
