# Installation

Install a Curiosity Workspace to your system using the following instructions.

# Developer Prerequisites

If you plan to develop custom extensions like data connectors or custom front-ends, ensure you have the following tools installed:

  • .NET SDK: Download and install the latest .NET SDK from dotnet.microsoft.com.
  • IDE: We recommend Visual Studio, Visual Studio Code, or JetBrains Rider.
  • H5 Compiler: Essential for compiling C# code into JavaScript for custom front-ends. Install it using the .NET CLI:

    dotnet tool update --global h5-compiler
  • Curiosity CLI: Necessary for managing your workspace and deployments from the command line:

    dotnet tool update --global Curiosity.CLI

# Workspace Installation

# Windows

  • Download the Curiosity Workspace for Windows install file here
  • Run the setup, and follow the instructions to install.
  • Once installed, open your start menu and run the "Curiosity Workspace" app.

# Docker

You must configure the values that are required for a standard installation. Unlike in the Installation guide, you cannot use a YAML file in the root folder of the app, therefore pass the configuration variables directly to the docker run command:

mkdir -p ~/curiosity/storage
docker run -p 8080:8080 -v ~/curiosity/storage/:/data/ -e storage=/data/curiosity curiosityai/curiosity

If you're running on Windows, you will need to adapt the paths as required:

mkdir c:\curiosity\storage
docker run -p 8080:8080 -v c:/curiosity/storage/data/:/data/ -e storage=/data/curiosity curiosityai/curiosity

# Docker Compose

Alternatively, you can use Docker Compose to manage your installation. Create a docker-compose.yml file with the following content:

version: '3.8'
services:
  curiosity:
    image: curiosityai/curiosity:latest
    ports:
      - "8080:8080"
    volumes:
      - ~/curiosity/storage:/data
    environment:
      - storage=/data/curiosity
    restart: unless-stopped

To start the workspace, run:

docker-compose up -d