mirror of
https://github.com/dathere/ckan-devstaller.git
synced 2025-11-09 13:39:49 +00:00
feat: update ckan-devstaller to v0.3.1
This commit is contained in:
parent
0e263202a1
commit
475bcc4932
21 changed files with 240 additions and 57 deletions
|
|
@ -4,6 +4,19 @@ description: Customize your CKAN installation before running ckan-devstaller.
|
|||
icon: Blocks
|
||||
---
|
||||
|
||||
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>
|
||||
|
||||
---
|
||||
|
||||
import Builder from "@/components/builder";
|
||||
|
||||
<Builder />
|
||||
|
|
|
|||
33
docs/content/docs/changelog/0.3.1.mdx
Normal file
33
docs/content/docs/changelog/0.3.1.mdx
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
title: Changelog for ckan-devstaller v0.3.1 (2025-10-30)
|
||||
---
|
||||
|
||||
## Updated CKAN default versions to latest stable versions
|
||||
|
||||
We have updated ckan-devstaller to suggest the recent releases of CKAN [2.11.4](https://docs.ckan.org/en/2.11/changelog.html#v-2-11-4-2025-10-29) and [2.10.9](https://docs.ckan.org/en/2.10/changelog.html#v-2-10-9-2025-10-29).
|
||||
|
||||
## Added the "Developing with WSL" page in the Reference section
|
||||
|
||||
Developers using Windows may benefit from the new [Developing with WSL](/docs/reference/developing-with-wsl) page in the Reference section to try their builds of ckan-devstaller and verify things work on a new install of Ubuntu 22.04.
|
||||
|
||||
Alternatively if not trying to reset an entire WSL environment, developers can look into [`ckan-devstaller uninstall`](/docs/tutorials/uninstall-ckan).
|
||||
|
||||
## Added install script switch to Builder page
|
||||
|
||||
There is now a switch on the Builder page that is enabled by default for including the installation script for ckan-devstaller before running it. This is necessary for users that don't have ckan-devstaller installed yet and are using the Builder over the Quick Start scripts.
|
||||
|
||||
## Default start with the Builder page
|
||||
|
||||
We've changed "Get Started" links (and similar links) to the Builder page instead of the Quick Start page to users can quickly access the Builder again and get started using ckan-devstaller.
|
||||
|
||||
## Update ckan-compose links to use ckan-devstaller branch
|
||||
|
||||
We've updated ckan-compose links to use [the ckan-devstaller branch](https://github.com/tino097/ckan-compose/tree/ckan-devstaller).
|
||||
|
||||
## Update VirtualBox notice with better formatting
|
||||
|
||||
To ensure users using VirtualBox see the full command for adding a user to the sudoers file, we've improved the formatting of the note.
|
||||
|
||||
## GitHub Action to verify CKAN install runs
|
||||
|
||||
We've added a GitHub Action to run on push to the main branch to verify that a CKAN-only install runs. This doesn't include verbose testing but rather ensuring that the ckan-devstaller finishes without errors.
|
||||
|
|
@ -4,14 +4,14 @@ 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) and other optional features, intended for development use in a new Ubuntu 22.04 instance.
|
||||
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 `sudo adduser <username> sudo` where `<username>` is your username then restart your VM and run the ckan-devstaller installer script.</Accordion>
|
||||
<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>
|
||||
|
||||
|
|
@ -42,16 +42,16 @@ import { Step, Steps } from 'fumadocs-ui/components/steps';
|
|||
|
||||
### Install the "CKAN-only" preset
|
||||
|
||||
By running the following script, ckan-devstaller will be downloaded and the default configuration for installing CKAN 2.11.3 with ckan-compose will be selected. You can then customize your configuration interactively in your terminal after running this script.
|
||||
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.0/install.bash | bash
|
||||
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.1/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.0/install.bash | bash -s skip-interactive
|
||||
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.1/install.bash | bash -s skip-interactive
|
||||
```
|
||||
|
||||
</Step>
|
||||
|
|
@ -62,7 +62,7 @@ wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.0/ins
|
|||
|
||||
The following script will download ckan-devstaller and select the following configuration:
|
||||
|
||||
- CKAN 2.11.3
|
||||
- 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)
|
||||
|
|
@ -73,13 +73,13 @@ The following script will download ckan-devstaller and select the following conf
|
|||
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.0/install.bash | bash -s dathere-default
|
||||
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.1/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.0/install.bash | bash -s dathere-default skip-interactive
|
||||
wget -O - https://github.com/dathere/ckan-devstaller/releases/download/0.3.1/install.bash | bash -s dathere-default skip-interactive
|
||||
```
|
||||
|
||||
</Step>
|
||||
|
|
|
|||
|
|
@ -3,10 +3,6 @@ title: Developing with WSL
|
|||
description: Tips on how to develop ckan-devstaller on a Windows machine by leveraging Windows Subsystem for Linux.
|
||||
---
|
||||
|
||||
<Callout title="Work in Progress" type="error">
|
||||
This page is a work in progress and is not intended to be used yet.
|
||||
</Callout>
|
||||
|
||||
When developing ckan-devstaller on Windows, using Windows Subsystem for Linux (WSL) can be advantageous to demo an Ubuntu 22.04 environment without having to set up a virtual machine.
|
||||
|
||||
import { Step, Steps } from 'fumadocs-ui/components/steps';
|
||||
|
|
@ -30,7 +26,6 @@ wsl --install Ubuntu-22.04 --version 2
|
|||
### Export a base image
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
Here's the expected set up where we create a WSL folder:
|
||||
|
||||
|
|
@ -42,12 +37,40 @@ Here's the expected set up where we create a WSL folder:
|
|||
| ├── cdr.vdhx
|
||||
```
|
||||
|
||||
First we'll generate the `images/ubuntu-22-04-snapshot.tar` file:
|
||||
|
||||
```bash
|
||||
wsl --export Ubuntu-22.04 ./images/ubuntu-22-04-snapshot.tar
|
||||
```
|
||||
|
||||
<Step>
|
||||
|
||||
### Generate a VDHX file for our new instance
|
||||
|
||||
Next we'll generate the `instances/cdr.vdhx` file, so we can run the following:
|
||||
|
||||
```bash
|
||||
wsl --import cdr ./instances ./images/ubuntu-22-04-snapshot.tar
|
||||
```
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
|
||||
### Access your new instance as root
|
||||
|
||||
Now try to access your new Ubuntu 22.04 instance `cdr` as the `root` user by running:
|
||||
|
||||
```bash
|
||||
wsl -d cdr
|
||||
```
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
|
||||
### Set yourself as the admin user on the instance and log in as the admin user
|
||||
|
||||
Once logged in as `root`, you'll want to edit the `/etc/wsl.conf` file and modify it so you can login as an admin user instead of `root`. We can use the `nano` editor to modify the file:
|
||||
|
||||
```bash
|
||||
|
|
@ -82,14 +105,27 @@ Run the instance again and you should be logged in as your admin user by default
|
|||
wsl -d cdr
|
||||
```
|
||||
|
||||
</Step>
|
||||
|
||||
<Step>
|
||||
|
||||
### Install ckan-devstaller
|
||||
|
||||
Great, now you can go to the home directory and run one of the [quick start](/docs) scripts:
|
||||
|
||||
```bash
|
||||
cd ~/
|
||||
```
|
||||
|
||||
</Step>
|
||||
</Steps>
|
||||
|
||||
## Removing your instance
|
||||
|
||||
When you want to remove your instance (e.g. so that you can start a brand new instance) then run the following to unregister it:
|
||||
|
||||
```bash
|
||||
wsl --unregister cdr
|
||||
```
|
||||
|
||||
Then you can follow the steps again from step 3 to generate and try out a new instance.
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ The configuration file for CKAN is installed at `/etc/ckan/default/ckan.ini`:
|
|||
|
||||
## ckan-compose
|
||||
|
||||
We install certain first-time install files and `ckan-compose` as a directory in the user's home (`~`) directory. For example for the user `adam`:
|
||||
We install certain first-time install files and [`ckan-compose`](https://github.com/tino097/ckan-compose/tree/ckan-devstaller) as a directory in the user's home (`~`) directory. For example for the user `adam`:
|
||||
|
||||
```files
|
||||
/home/adam
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"pages": [
|
||||
"...",
|
||||
"!developing-with-wsl"
|
||||
"installation-architecture",
|
||||
"developing-with-wsl"
|
||||
]
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue