Welcome to Turkle’s documentation!

Contents:

• Turkle
  • Turkle Workflow Overview
• Installation
  • Download
  • Dependencies
  • One-time Configuration Steps
  • Upgrading
• Usage
  • Running the development server
• Developers
  • Running tests
  • Style Guideline
  • Building Docs
  • Release process
• Quick Start Guide
  • Installing OS packages
  • Configuring the database
  • Clone Turkle code and configure
  • Install Turkle
  • Configuring Logging
  • Setting Up Task Expiration
  • Database Backups
  • Not covered
• Administration Guide
  • Production Webserver Configuration
    • Configuring Static Files
    • Running with Gunicorn
    • Apache as a reverse proxy
    • Emails behind proxy
  • Production Database Configuration
    • MySQL
    • PostgreSQL
  • Database Backups
  • Cron
  • Email Configuration
  • Logging Configuration
• Docker
  • Prebuilt Docker images
  • Build SQLite Docker image
  • MySQL Docker image
  • Changing the admin password
  • Changing the number of threads, workers and worker connections
  • Logging
  • Running Dockerized Turkle with a URL prefix
  • Customizing the settings of Docker image
• App
  • Installing
• REST API
  • Client
  • Authentication
  • Users
    • Listing users
    • Creating a user
    • Retrieving a user
    • Update a user
  • Groups
    • Listing groups
    • Creating a group
    • Retrieving a group
    • Adding users to a group
  • Projects
    • Listing projects
    • Creating a project
    • Retrieving a project
    • Update a project
  • Batches
    • Listing batches
    • Creating a batch
    • Retrieving a batch
    • Update a batch
    • Batch status
  • Permissions
• Requestors
  • Creating groups
  • Creating users
  • Creating projects
  • Creating batches
  • Downloading results
    • Output CSV Format
  • Scripts for requesters
    • Adding users
    • Adding tasks
    • Downloading results
• Turkle Template Guide
  • How Turkle renders Templates
  • Template Variables
  • Serialized Data
  • JavaScript and CSS
  • Preventing Default Browser Behavior that Affects Data Quality
  • Gotchas

Indices and tables

• Index

• Search Page