Curiosity for Developers
  • Overview
  • Getting Started
    • Introduction
    • System Overview
      • Workspace
      • Connectors
      • Front End
    • Requirements
    • Installation
      • Deploying on Windows
        • Download Curiosity Workspace for Windows
      • Deploying on Docker
        • Deploying using Docker Desktop App
        • Docker Hub
      • Deploying on Kubernetes
      • Deploying on OpenShift
      • Configuration
    • Configure your Workspace
    • Connecting to a Workspace
      • Download App
    • Built-in Templates
  • Security
    • Introduction
    • Hosting
    • Encryption
    • Users and Access
      • User Invitations
      • Single Sign-On (SSO)
        • Google Sign-In
        • Microsoft / Azure AD
        • Okta
        • Auth0
    • Permissions Management
    • Auditing
    • Teams management
    • Configuring Backup
      • Restoring a backup
    • Activate a workspace license
  • Data Sources
    • Introduction
    • User Apps
    • Workspace Integrations
    • API Integrations
      • Introduction
      • Data Modeling
      • Writing a Connector
      • Access Control
      • API Tokens
      • API Overview
      • Tips
    • Supported File Types
    • Curiosity CLI
      • Installation
      • Authentication
      • Commands
  • Search
    • Introduction
    • Languages
    • Synonyms
    • Ranking
    • Filters
    • Search Permissions and Access Control
  • Endpoints
    • Introduction
    • Creating an endpoint
    • Calling an endpoint
    • Endpoint Tokens
    • Endpoints API
  • Interfaces
    • Introduction
    • Local Development
    • Deploying a new interface
    • Routing
    • Node Renderers
    • Sidebar
    • Views
  • Artificial Intelligence
    • Introduction
    • Embeddings Search
    • AI Assistant
      • Enabling AI Assistant
    • Large Language Models
      • LLMs Models Configuration
      • Self-Hosted Models
    • Image Search
    • Audio and Video Search
  • Sample Workspaces
    • Introduction
    • HackerNews
    • Aviation Incidents
    • Covid Papers
    • NASA Public Library
    • Suggest a Recipe
  • Basic Concepts
    • Graph database
    • Search Engine
  • Troubleshooting
    • FAQs
      • How long does it take to set up?
      • How does Curiosity keep my data safe?
      • Can we get Curiosity on-premises?
      • Can I connect custom data?
      • How does Workspace pricing work?
      • Which LLM does Curiosity use?
      • What's special about Curiosity?
      • How are access permissions handled?
      • What enterprise tools can I connect?
      • How to access a workspace?
      • How do I hard refresh my browser?
      • How do I report bugs?
      • How do I solve connectivity issues?
      • How do I contact support?
  • Policies
    • Terms of Service
    • Privacy Policy
Powered by GitBook
On this page
  • Configuration Variables
  • Ports & Certificates
  • Data Storage
  • License (optional)
  • Backup (optional)
  • Data Encryption (optional)
  • Administrator Account (optional)
  1. Getting Started
  2. Installation

Configuration

PreviousDeploying on OpenShiftNextConfigure your Workspace

Last updated 1 year ago

Curiosity supports configuration via environment variables that are passed to the , command like arguments or a YAML config file curiosity.yml for local installations (i.e. , or ), . which needs to be located in the installation folder.

Configuration Variables

Ports & Certificates

  • MSK_PORT=8080 port for the server to listen for http/https connections.

  • optional MSK_CERT_SELF_SIGNED=true enables HTTPS using a self-signed certificate

  • optional MSK_CERT_FILE=/path/to/certificate.crt enables HTTPS using an existing certificate (this can also be configured directly in the user-interface). If your certificate is password protected, you'll need to pass the password using MSK_CERT_PWD

  • optional MSK_SERVER_BASE_PATH=/myapp Changes the root path in which the server listens for connections - i.e. to for example. Defaults to /.

Data Storage

  • MSK_GRAPH_STORAGE=/data/storage/ base path where the graph database, models and associated files will be stored. In case you don't use the variables below, it will also contain the front-end code and database write-ahead journal files.

  • optional MSK_WWW_FOLDER=/data/www overwrite the storage location for the front-end files.

  • optional MSK_GRAPH_JOURNAL_FOLDER=/data/journal/ overwrite the storage location for the write-ahead journal

  • optional MSK_GRAPH_TEMP_FOLDER=/tmp/ overwrite the storage location for temporary files.

License (optional)

The following two variables when used together set the license to be used by the system. This can also be done once the system is up and running during the and later in the .

  • optional MSK_LICENSE=MyCompanyName

  • optional MSK_LICENSED_TO=MyLicenseToken

Backup (optional)

  • MSK_GRAPH_BACKUP_FOLDER=/data/backup/

Data Encryption (optional)

Administrator Account (optional)

You can reset the administrator account in case you changed it by mistake, by setting the variables below together.

  • MSK_ADMIN_USER=admin

  • MSK_ADMIN_EMAIL=admin@mycompany.com

  • MSK_ADMIN_PASSWORD=AdministratorPassword

Configure the location where incremental backups of the graph data will be stored. If set, this will automatically add a scheduled backup task to run once a day at night. You can configure this task in the page.

MSK_GRAPH_MASTER_KEY=Base64EncodedEncryptionKey Enable full graph encryption. Check the article on for more information on how to create one.

Docker container
Windows
macOS
Linux
http://localhost/myapp
initial setup
License Settings page
Scheduled Tasks Settings
data encryption