Cantabular logo
  • Documentation
  • Contact us

Quick search

Table of Contents

Getting started

  • About Cantabular
  • Installation guide
    • Installation
    • Executables overview
    • Validate installation
    • Logging and monitoring
    • Improving performance with HTTP caching
    • Configuring the public user interface
  • Loading data
  • Codebook format
  • Release notes

Technical

  • GraphQL API
  • Metadata service
  • Disclosure rules language
 
  • ← About Cantabular
  • Installation →

Cantabular Installation GuideΒΆ

Contents:

  • Installation
    • Cantabular software package
    • Location
    • Services on Linux
    • Services on Windows
    • License file
    • Folder structure
  • Executables overview
    • cantabular-make-dataset
    • cantabular-server
    • cantabular-api-ext
    • cantabular-metadata
    • cantabular-ui
    • cantabular-admin
    • cantabular-inspect
    • cantabular-hash-password
  • Validate installation
    • Create dataset
    • Inspect dataset
    • Serve dataset
    • Serve metadata
    • Access UI
    • Access GraphiQL UI
    • Query flow dataset
  • Logging and monitoring
    • Overview
    • Logging
    • Maximum request concurrency
    • Health check endpoint
    • Metrics endpoint
  • Improving performance with HTTP caching
    • Overview
    • Configuring the service to support caching
    • Disabling caching
    • Configuring Nginx
  • Configuring the public user interface
    • Overview
    • Connecting to cantabular-metadata
    • Standard tables in the user interface
    • Localization
    • Custom templates
    • Themes
    • Customising Excel downloads
    • Adding third-party JavaScript
    • Authentication
    • Query result buffering
 
  • ← About Cantabular
  • Installation →

© 2025 Cantabular Ltd | Terms & Conditions | Privacy policy