diff --git a/Cargo.lock b/Cargo.lock
index 6bd3e74..fbf07de 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -126,7 +126,7 @@ checksum = "9555578bc9e57714c812a1f84e4fc5b4d21fcb063490c624de019f7464c91268"
[[package]]
name = "ckan-devstaller"
-version = "0.3.0"
+version = "0.1.0"
dependencies = [
"anyhow",
"clap",
diff --git a/Cargo.toml b/Cargo.toml
index 732c927..63bfc7a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "ckan-devstaller"
-version = "0.3.0"
+version = "0.1.0"
edition = "2024"
[dependencies]
diff --git a/README.md b/README.md
index 538a5b7..72cd505 100644
--- a/README.md
+++ b/README.md
@@ -1,36 +1,42 @@
# ckan-devstaller
-
+`ckan-devstaller` attempts to install CKAN 2.11.3 from source using [ckan-compose](https://github.com/tino097/ckan-compose), intended for development use in a new Ubuntu 22.04 instance. The following are also installed and enabled by default:
+- [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)
-`ckan-devstaller` attempts to install a [CKAN](https://ckan.org) instance using [ckan-compose](https://github.com/tino097/ckan-compose) for development usage in a new Ubuntu 22.04 instance.
+[DRUF mode](https://github.com/dathere/datapusher-plus?tab=readme-ov-file#druf-dataset-resource-upload-first-workflow) is available but disabled by default. The [`datatablesview-plus` extension](https://github.com/dathere/ckanext-datatables-plus) is planned to be included in a future release.
-You may find `ckan-devstaller` useful for:
+## Quick start
-- Exploring CKAN for the first time without spending hours on installation steps
-- Developing/Testing CKAN extensions and fixing bugs
-- Trying a new CKAN version to test an upgrade from a legacy version
+> [!CAUTION]
+> 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.
-`ckan-devstaller` was made to help speed up the installation time for CKAN and various extensions/features to boost development productivity.
+> [!WARNING]
+> 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 `sudo adduser sudo` where `` is your username then restart your VM and run the ckan-devstaller installer script.
-**Get started at [ckan-devstaller.dathere.com](https://ckan-devstaller.dathere.com).**
+> [!NOTE]
+> The `/etc/ckan/default/ckan.ini` config file will have its comments removed for now. There are plans to fix this in a future release of `ckan-devstaller`.
-## Learn more about developing with CKAN
+> [!NOTE]
+> Currently `ckan-devstaller` supports x86 architecture. ARM support is planned.
-You may find the following guides useful while developing with CKAN:
+You have two common options to choose from for installation. Paste one of the following scripts into your new Ubuntu 22.04 instance's terminal.
-- [CKAN Hardware Requirements](https://github.com/ckan/ckan/wiki/Hardware-Requirements) - Learn what you need before installing CKAN
-- [CKAN Sysadmin guide](https://docs.ckan.org/en/latest/sysadmin-guide.html) - Useful for CKAN instance administrators/sysadmins
-- [CKAN Theming guide](https://docs.ckan.org/en/latest/theming/index.html) - Explore how to set up custom themes for your CKAN instance
-- [CKAN Extending guide](https://docs.ckan.org/en/latest/extensions/index.html) - Develop CKAN extensions that can enhance your CKAN instance's functionality and add custom features
+### Install with non-interactive mode (default config)
-## What next?
+```bash
+wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.2.1/install.bash | bash -s default
+```
-- [Customize your config file](https://docs.ckan.org/en/latest/extensions/index.html)
-- [Create test data](https://docs.ckan.org/en/latest/maintaining/getting-started.html#creating-test-data)
-- [Visit ckan.org](https://ckan.org)
+### Install with interactive mode
-## `ckan-devstaller` demos
+```bash
+wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.2.1/install.bash | bash
+```
+
+## Demos
### Interactive customizable installation
diff --git a/docs/app/(home)/page.tsx b/docs/app/(home)/page.tsx
index 8a86dce..5598564 100644
--- a/docs/app/(home)/page.tsx
+++ b/docs/app/(home)/page.tsx
@@ -38,6 +38,33 @@ export default function HomePage() {
+
+ }
+ href="/docs/quick-start"
+ title="Quick start"
+ >
+ Get started with ckan-devstaller and install CKAN within minutes
+
+ } href="/docs/builder" title="Builder">
+ Customize your installation with an interactive web GUI
+
+ }
+ href="/docs/reference/installation-architecture"
+ title="Installation architecture"
+ >
+ Learn about where files are installed after running
+ ckan-devstaller
+
+ }
+ href="https://github.com/dathere/ckan-devstaller"
+ title="Source code"
+ >
+ View the source code of ckan-devstaller on GitHub
+
+
>
@@ -45,7 +72,6 @@ export default function HomePage() {
}
function Hero() {
- const { Card, Cards } = defaultMdxComponents;
return (
.
-
+
-
- }
- href="/docs"
- title="Quick start"
- >
- Get started with ckan-devstaller and install CKAN within minutes
-
- } href="/docs/builder" title="Builder">
- Customize your installation with an interactive web GUI
-
- }
- href="/docs/reference/installation-architecture"
- title="Installation architecture"
- >
- Learn about where files are installed after running
- ckan-devstaller
-
- }
- href="https://github.com/dathere/ckan-devstaller"
- title="Source code"
- >
- View the source code of ckan-devstaller on GitHub
-
-