# Draftable ## Introduction to Draftable ### Getting Started #### - [Welcome to Draftable](https://help.draftable.com/hc/en-us/articles/Welcome.md): Get started with our comprehensive documentation and learn how Draftable can help you compare documents efficiently. - [Our Draftable Product Family](https://help.draftable.com/hc/en-us/articles/Our-Draftable-Product-Family.md): Learn about the different Draftable products available and find the right solution for your document comparison and metadata cleaning needs. - [What kind of Draftable user are you?](https://help.draftable.com/hc/en-us/articles/What-kind-of-Draftable-user-are-you.md): Find the right documentation path based on whether you're an end user or an administrator deploying Draftable. - [How to navigate our docs](https://help.draftable.com/hc/en-us/articles/How-to-navigate-our-docs.md): Learn how to effectively navigate and find the information you need in the Draftable documentation. #### Contact Us - [Contacting the Draftable Product Team](https://help.draftable.com/hc/en-us/articles/43674043240473-Contacting-the-Draftable-Product-Team.md): Our **Product Team** is always keen to hear from you! Whether you have **questions about our products**, want to **request new features**, or need help with **preview features** that haven't been fully released yet, we’re here to listen. - [Contacting Draftable Support](https://help.draftable.com/hc/en-us/articles/43674001541273-Contacting-Draftable-Support.md): At Draftable, we’re here to help! Whether you have a **technical issue**, a **product question**, need assistance with **integrations**, or have **any other inquiries**, our support team is ready to assist you. #### Other resources - [Looking for Affinda?](https://help.draftable.com/hc/en-us/articles/49898180105881-Looking-for-Affinda.md): If you’ve landed on the Draftable Help Center but were actually looking for **Affinda**, you’re in the right family, just the wrong help site. Affinda is Draftable’s sister company and focuses on AI-powered document processing (e.g., invoice extraction, resume parsing, and custom Document parsing). - [Draftable and macOS support](https://help.draftable.com/hc/en-us/articles/Draftable-and-macOS-support.md): Information about Draftable's current macOS compatibility and future plans for Mac support. ### Security & Compliance #### Overview - [Security and compliance at Draftable](https://help.draftable.com/hc/en-us/articles/Security-and-compliance-at-Draftable.md): An overview of Draftable's security programme: certifications, encryption standards, independent testing, resilience, and how to request our compliance documentation. - [Security and privacy FAQ](https://help.draftable.com/hc/en-us/articles/Security-and-privacy-FAQ.md): Answers to the questions we are asked most often during security reviews: certifications, hosting, retention, encryption, AI, staff access, breach notification, and questionnaires. #### Security by product - [Document security with Draftable Legal and Business](https://help.draftable.com/hc/en-us/articles/Document-security-with-Draftable-Legal.md): How Draftable Legal and Business handle your documents: local processing, exactly what leaves the machine, telemetry and error reporting controls, DMS connections, and administrator controls. - [Document Privacy and Security with the Draftable API](https://help.draftable.com/hc/en-us/articles/42553018962841-Document-Privacy-with-Draftable-API.md): How the Draftable API protects your documents: hosting, data lifecycle control, retention and deletion, encryption in transit and at rest, and our compliance certifications. - [Document security with Draftable Online](https://help.draftable.com/hc/en-us/articles/Document-security-with-Draftable-Online.md): How Draftable Online handles the files you upload: hosting, encryption, how long comparisons are kept, how to request deletion, and when to use a different Draftable product instead. #### Documentation & reporting - [Accessing Draftable’s Compliance & Security Documentation](https://help.draftable.com/hc/en-us/articles/49898032588569-Accessing-Draftable-s-Compliance-Security-Documentation.md): This article explains where customers and reviewers can find Draftable’s latest compliance, privacy, and security information, and what you can expect to see there. - [Vulnerability Reporting](https://help.draftable.com/hc/en-us/articles/16226110503961-Vulnerability-Reporting.md) ### Product FAQs #### Product FAQs - [Draftable Legal Frequently Asked Questions](https://help.draftable.com/hc/en-us/articles/Draftable-Legal-FAQ.md): This FAQ page is meant to be an all-in-one resource for all Draftable Legal users looking for quick answers to questions. We recommend that if you want a more in-depth view of some of these topics you look at the dedicated article, however, this FAQ is designed to assist you as quickly as possible. - [Draftable Clean Frequently Asked Questions](https://help.draftable.com/hc/en-us/articles/Draftable-Clean-Frequently-Asked-Questions.md): Quick answers to common Draftable Clean questions — file types, local processing, the Outlook add-in, deployment, DMS integrations, cleaning profiles, and licensing. For a more in-depth view, follow the link in each answer. - [Draftable Online Frequently Asked Questions](https://help.draftable.com/hc/en-us/articles/Draftable-Online-Frequently-Asked-Questions.md): Frequently asked questions about Draftable Online, our free document comparison tool available in your browser. - [Release Notes (48 pages)](https://help.draftable.com/_llms/release-notes.txt): Documentation for Release Notes. - [Draftable Legal (178 pages)](https://help.draftable.com/_llms/draftable-legal.txt): Documentation for Draftable Legal . ## Draftable Clean ### User Overview #### Getting Started - [What is Draftable Clean?](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/What-is-Draftable-Clean.md): Draftable Clean is a metadata cleaning solution that scans, identifies, and removes hidden metadata from your documents before sharing — helping legal professionals protect sensitive and privileged information. #### About Draftable Clean - [Draftable Clean Supported Metadata Types](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Supported-Metadata-Types.md): A comprehensive reference of all metadata types that Draftable Clean can detect and clean across Word, Excel, PowerPoint, PDF, and image files — including supported actions, risk levels, and applicable file types. - [Draftable Clean Supported file types](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Supported-file-types.md): Draftable Clean supports metadata scanning and cleaning for Word, PDF, Excel, PowerPoint, image, and ZIP files — including password-protected files. #### Using Draftable Clean - [Single-user Installation](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Single-user-Installation.md): Install Draftable Clean on your Windows PC using the per-user installer, activate your license or start a free trial, and get the Outlook add-in from your administrator. - [Draftable Clean Quick Start Guide](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Draftable-Clean-Quick-Start-Guide.md): Walk through using the Draftable Clean desktop application and Outlook add-in to scan, review, and clean documents before sharing. - [Using the Desktop Application](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Using-the-Desktop-Application.md): Learn how to upload, scan, clean, and export documents using the Draftable Clean desktop application on Windows. - [Using the Outlook Add-in](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Using-the-Outlook-Add-in.md): Learn how to clean email attachments automatically using the Draftable Clean Outlook add-in, including profile switching, PDF conversion, and send protection. - [Enable the Windows 11 right-click menu for Draftable Clean](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Enable-the-Windows-11-right-click-menu-for-Draftable-Clean.md): Add the Clean in Draftable command to the main Windows 11 right-click menu so you can clean document metadata straight from File Explorer. ### Admin Setup & Customization #### Requirements - [Draftable Clean System Requirements](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/System-Requirements.md): Your computer must meet the minimum and recommended technical specifications outlined below to run Draftable Clean. - [Draftable Clean Network Requirements](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Network-Requirements.md): This article outlines the network connectivity requirements for Draftable Clean, including license verification, updates, DMS integrations, and telemetry. #### Enterprise Deployment - [Enterprise Deployment](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Deployment-options.md): Deploy Draftable Clean across your organization using the machine-wide MSI installer — for Citrix, RDS, and enterprise rollouts. - [Installing Draftable Clean Outlook Add-in](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Installing-Draftable-Clean-Outlook-Add-in.md): Step-by-step instructions for Microsoft 365 administrators to deploy the Draftable Clean Outlook Add-in organization-wide, enabling automatic metadata cleaning of email attachments. - [Configuring preferences for your organization](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Configuring-preferences-for-your-organisation-Draftable-Clean.md): Overview for system administrators centrally configuring Draftable Clean across their organization using Group Policy, registry settings, or Microsoft Intune. - [Configuring preferences with Group Policy (Draftable Clean)](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Configuring-preferences-with-Group-Policy-Draftable-Clean.md): Centrally configure Draftable Clean across your organization using Active Directory Group Policy and ADMX administrative templates — including admin cleaning profiles, iManage and NetDocuments integration, Outlook add-in lockdown, and must-clean metadata enforcement. - [Configuring preferences with Microsoft Intune (Draftable Clean)](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Configuring-preferences-with-Microsoft-Intune-Draftable-Clean.md): Centrally configure Draftable Clean on cloud-managed Windows devices using Microsoft Intune — by importing ADMX administrative templates or deploying registry settings via OMA-URI configuration profiles. #### Managing Draftable - [Updating Draftable Clean](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Updating-Draftable-Clean.md): This article explains how updates work in Draftable Clean, how to check which version is currently installed, and how to manually apply updates. - [How to deactivate your Draftable Clean license](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/How-to-deactivate-your-Draftable-Clean-license.md): If you need to deactivate a Draftable Clean license — for example, to move it to a different machine — this article walks you through the process. #### Customization - [Draftable Clean Metadata cleaning profiles](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Metadata-Cleaning-Profiles.md): Learn how to create, configure, and manage cleaning profiles in Draftable Clean to control exactly which metadata is removed from your documents. ### FAQ & Troubleshooting #### FAQ - [Frequently Asked Questions](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Frequently-Asked-Questions.md): Quick answers to common Draftable Clean questions — file types, local processing, the Outlook add-in, deployment, DMS integrations, cleaning profiles, and licensing. For a more in-depth view, follow the link in each answer. #### Troubleshooting - [Draftable Clean Troubleshooting](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Troubleshooting.md): Find solutions to common Draftable Clean issues — cleaning problems, licensing, DMS integrations, diagnostic logs, and contacting support. - [Troubleshooting: Licensing](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Troubleshooting-Licensing.md): Solutions for Draftable Clean licensing issues, including checking license status, activating licenses, and transferring licenses between machines. - [Troubleshooting: DMS integrations](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Troubleshooting-DMS-Integrations.md): Solutions for iManage, NetDocuments, and SharePoint integration issues in Draftable Clean, including enabling integrations and resolving connection problems. - [Troubleshooting: Cleaning issues](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Troubleshooting-Cleaning-Issues.md): Solutions for common cleaning issues in Draftable Clean, including password-protected files, metadata not being removed, cryptographically signed PDFs, and unsupported file types. - [Troubleshooting: Outlook Add-in](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Troubleshooting-Outlook-Add-in.md): Solutions for common Draftable Clean Outlook add-in issues — deployment, manifest validation, cleaning failures, updates, cache clearing, and removal. - [Troubleshooting: Diagnostic logs and support](https://help.draftable.com/hc/en-us/Draftable-Clean-articles/Troubleshooting-Diagnostic-Logs-and-Support.md): How to export diagnostic logs, clear the Outlook add-in cache, and contact Draftable support for help with Draftable Clean issues. ## Draftable Business ### Overview & Setup #### Getting Started - [Draftable Business (Draftable Compare for Enterprise) Quick Start Guide](https://help.draftable.com/hc/en-us/articles/10301668955673-Draftable-Business-Quick-Start-Guide.md): This article can help you set up Draftable Business and run a comparison within minutes! - [What is Draftable Business (Draftable Compare for Enterprise)?](https://help.draftable.com/hc/en-us/articles/10301508835225-What-is-Draftable-Business.md): Draftable Business is a document comparison solution for teams and individuals that makes it easy to see what's changed between two documents. - [Understanding Draftable Legal vs Draftable Business](https://help.draftable.com/hc/en-us/articles/51498434438553-Understanding-Draftable-Legal-vs-Draftable-Business.md): A complete breakdown of what separates Draftable Legal from Draftable Business: comparison outputs, DMS integrations, customization, and the workflows each product is built for. #### Requirements - [System Requirements](https://help.draftable.com/hc/en-us/articles/6142284007449-System-Requirements.md): Your computer must meet the minimum & recommended technical specifications outlined below to run and use Draftable Business. - [Network Requirements](https://help.draftable.com/hc/en-us/articles/6142385828249-Network-Requirements.md): This article is for IT or network administrators responsible for managing an organization's network. - [Supported file types](https://help.draftable.com/hc/en-us/articles/10301511489817-Supported-file-types.md) ### Using Draftable Business #### Core Usage - [Comparison Outputs](https://help.draftable.com/hc/en-us/articles/6140816202393-Comparison-Outputs.md): A comparison output is document produced by Draftable that contain a part of, or whole comparison. It can be shared with colleagues, archived for compliance/record-keeping purposes, etc. There are 3 comparison outputs: side-by-side PDF, single document view PDF and Tracked Changes document. - [New Comparison Workflow: Choose between tab or window mode](https://help.draftable.com/hc/en-us/articles/New-Comparison-Workflow-Tab-or-Window-in-Draftable-Business.md): Learn how to configure whether new comparisons in Draftable Business open in a new tab within the application or as a separate window. #### Updates - [Updating Draftable Business](https://help.draftable.com/hc/en-us/articles/10301718530585-Updating-Draftable-Business.md): This article explains how updates work in Draftable Business, how to check which version is currently installed and how to manually apply updates. ### Admin & Customization #### Enterprise Deployment - [Enterprise deployment options](https://help.draftable.com/hc/en-us/articles/6142316169625-Enterprise-deployment-options.md): This article is for IT administrators looking to deploy Draftable Desktop across their organization. - [Configuring preferences with Group Policy (Draftable Business)](https://help.draftable.com/hc/en-us/articles/6142412798233-Configuring-preferences-with-Group-Policy-Draftable-Business.md): This article is for system administrators who are interested in using Group Policy to deploy & configure Draftable Business across an organization as part of an [enterprise deployment.](/hc/en-us/articles/6142316169625-Enterprise-deployment-options) #### Managing Draftable - [How to deactivate your Draftable Business license](https://help.draftable.com/hc/en-us/articles/18357660925465-How-to-deactivate-your-Draftable-Business-license.md): If you're looking to deactivate an unused Draftable Business license, it's important to understand the process to avoid any potential issues. This knowledge base article, will guide you through the steps involved in deactivating a license, including contacting the Draftable support team to notify of… #### Customization - [Changes markup theme options for Draftable Business](https://help.draftable.com/hc/en-us/articles/21436727062297-Changes-markup-theme-options-for-Draftable-Business.md): Draftable Business offers users the power to change the viewer markup theme option, to make comparisons look and feel closer to their tailored needs. ### Troubleshooting #### Troubleshooting - [Side-by-Side Document Compare Failure in Draftable Business](https://help.draftable.com/hc/en-us/articles/20876814164377-Side-by-Side-Document-Compare-Failure-in-Draftable-Business.md): If you are seeing this article, it is likely that Draftable Business has detected a failure in the side-by-side document comparison feature. There could be several causes for this issue, from permission-related problems to document corruption. Unfortunately, because this issue is complex and has var… - [My product key isn't being accepted](https://help.draftable.com/hc/en-us/articles/My-product-key-isnt-being-accepted.md): If your Draftable Business product key isn't being accepted, it's likely because all activations on your license have been used. This article explains why this happens and how to resolve it. ## Draftable API ### Overview & Usage #### Getting started - [Getting started with the Draftable API](https://help.draftable.com/hc/en-us/articles/Draftable-API-getting-started.md): An introduction to the Draftable API: what it does, how a comparison flows through it, and a complete first request from credentials to viewable result. - [Authenticating with the Draftable API](https://help.draftable.com/hc/en-us/articles/Draftable-API-authentication.md): How Draftable API credentials work, how to send them, where to find them, and how to keep them safe. - [Test and production accounts in the Draftable API](https://help.draftable.com/hc/en-us/articles/Draftable-API-test-and-production-accounts.md): Every Draftable API account comes with two sets of credentials, one labelled test and one labelled production. This article explains what the difference actually is and how to use them. - [Using the Draftable API Explorer](https://help.draftable.com/hc/en-us/articles/Draftable-API-using-the-api-explorer.md): The API Explorer is an interactive reference at api.draftable.com where you can read every endpoint's parameters and run real requests against your test account from the browser. #### Creating comparisons - [Creating a comparison with the Draftable API](https://help.draftable.com/hc/en-us/articles/Draftable-API-creating-a-comparison.md): A full reference for creating comparisons: uploading files versus supplying URLs, supported file types, identifiers, expiry, and public comparisons. - [Submitting files: direct upload or source URL](https://help.draftable.com/hc/en-us/articles/Draftable-API-submitting-files.md): The two ways to give Draftable your documents, when to use each, and why pre-signed storage URLs are usually the best option for files already in S3 or Azure. - [Comparison speeds and batch processing](https://help.draftable.com/hc/en-us/articles/Draftable-API-comparison-speeds.md): How long Draftable API comparisons typically take, why PDFs are faster than Word documents, and how batch jobs are prioritised and processed in parallel. #### Viewing and sharing - [Viewing and sharing comparison results](https://help.draftable.com/hc/en-us/articles/Draftable-API-viewing-and-sharing-results.md): How to know when a comparison is ready, how to build public and signed viewer URLs, and how the wait parameter removes the need to poll. - [Private and public comparisons](https://help.draftable.com/hc/en-us/articles/Draftable-API-private-comparisons.md): Comparisons are private by default. This article explains what that means, how signed viewer URLs authorise access, and when a public comparison is the right choice. - [Embedding comparisons in your app](https://help.draftable.com/hc/en-us/articles/Draftable-API-embedding-comparisons.md): How to embed the Draftable comparison viewer directly into your own application with an iframe, and what the viewer does while it loads or fails. #### Exports and data - [Exporting a comparison to PDF](https://help.draftable.com/hc/en-us/articles/Draftable-API-exporting-comparisons.md): How to turn a completed Draftable API comparison into a downloadable PDF, including the four export kinds and how to retrieve the finished file. - [Getting Comparison Results as a JSON via the Change-Details Endpoint (API)](https://help.draftable.com/hc/en-us/articles/37873922031129-Getting-Comparison-Results-as-a-JSON-via-the-Change-Details-Endpoint-API.md): The change-details endpoint allows you to retrieve comparison results as a structured JSON response, including individual changes, style information, positional data, and a summary of all differences found. - [How to Delete Comparisons in Draftable API](https://help.draftable.com/hc/en-us/articles/How-to-delete-comparisons-in-Draftable-API.md): Learn the different methods for deleting comparisons and managing document storage in Draftable API, including manual deletion, automatic expiry, and understanding URL expiry. #### Account & customization - [Generating a new API key](https://help.draftable.com/hc/en-us/articles/Draftable-API-generating-a-new-api-key.md): How to reset your Draftable API auth token from your account, what it affects, and what to prepare before you do it. - [Multi-factor authentication for your Draftable API account](https://help.draftable.com/hc/en-us/articles/Draftable-API-multi-factor-authentication.md): The Draftable API supports multi-factor authentication on your account sign-in using an authenticator app. This article explains what it protects, how to enable it, and how it relates to your API credentials. - [Customizing your Draftable API account and comparison viewer](https://help.draftable.com/hc/en-us/articles/Customizing-your-Draftable-API-account-and-viewer.md): Draftable API accounts can be tailored to your needs – from the comparison viewer's appearance and controls to the way changes are displayed. These settings are managed by the Draftable team. This article explains what you can request and how to request it. - [Requesting usage reports for your Draftable API account](https://help.draftable.com/hc/en-us/articles/Requesting-usage-reports-for-your-Draftable-API-account.md): Draftable can provide usage reports for your API account on request, showing how many comparisons your account has generated. This article explains what the reports contain and how to request one. #### Troubleshooting & status - [Handling errors and comparison failures](https://help.draftable.com/hc/en-us/articles/Draftable-API-handling-errors.md): The two kinds of failure in the Draftable API, the HTTP status codes you should handle, and how to diagnose a comparison that finished unsuccessfully. - [Checking Draftable API Status](https://help.draftable.com/hc/en-us/articles/43677873463705-Checking-Draftable-API-Status.md): If you’re experiencing issues with Draftable’s API services or want to stay informed about **downtime, maintenance, or system updates**, you can check our **API Status Page** for real-time updates. - [Document Privacy and Security with the Draftable API](https://help.draftable.com/hc/en-us/articles/42553018962841-Document-Privacy-with-Draftable-API.md): How the Draftable API protects your documents: hosting, data lifecycle control, retention and deletion, encryption in transit and at rest, and our compliance certifications. ## Draftable APISH ### v3 #### Overview & Setup ##### Getting Started - [API Self Hosted v3 – Quick Start Guide](https://help.draftable.com/hc/en-us/articles/51133475373465-API-Self-Hosted-v3-Quick-Start-Guide.md): This guide will help you set up and run API Self Hosted v3 in a Docker-based environment. Follow the steps below to get up and running in minutes. - [Network requirements](https://help.draftable.com/hc/en-us/articles/12042585710489-Network-requirements.md): Draftable API Self-hosted container requires internet access to activate the license. ##### Configuration - [Draftable API Self Hosted v3 Docker Compose Guide](https://help.draftable.com/hc/en-us/articles/51141426113049-Draftable-API-Self-Hosted-v3-Docker-Compose-Guide.md): This is a guide for the Docker Compose file used in the API Self Hosted v3 image. - [API Self-Hosted v3 – Using a private or internal CA](https://help.draftable.com/hc/en-us/articles/API-Self-Hosted-v3-Using-a-Private-or-Internal-CA.md): How to make Draftable API Self-Hosted v3 trust a private or internal certificate authority, for TLS-enabled RabbitMQ and Redis and for outbound HTTPS such as licence activation through an inspecting proxy. - [API Self-Hosted v3 – Understanding fonts and font substitution](https://help.draftable.com/hc/en-us/articles/API-Self-Hosted-v3-Understanding-Fonts.md): Why comparisons on API Self-Hosted can report style changes for fonts that are not in your documents, which fonts ship with the product, and how to upload your own. ##### Deployment Guides - [API Self-Hosted v3 – Kubernetes Deployment Guide](https://help.draftable.com/hc/en-us/articles/API-Self-Hosted-v3-Kubernetes-Deployment-Guide.md): Guide for deploying Draftable API Self-Hosted v3 on Kubernetes using local file storage. - [API Self-Hosted v3 – AWS EKS Deployment Guide (S3 Storage)](https://help.draftable.com/hc/en-us/articles/API-Self-Hosted-v3-AWS-EKS-Deployment-Guide.md): Complete guide for deploying Draftable API Self-Hosted v3 on AWS Elastic Kubernetes Service (EKS) with S3 storage backend. - [API Self-Hosted v3 – Azure AKS Deployment Guide](https://help.draftable.com/hc/en-us/articles/API-Self-Hosted-v3-Azure-AKS-Deployment-Guide.md): Draftable does not recommend deploying API Self-Hosted v3 on Azure AKS. It requires unsupported network file share storage. This guide is for customers with no alternative, and documents the trade-offs and support boundaries. - [API Self-Hosted v3 – Podman Deployment Guide](https://help.draftable.com/hc/en-us/articles/API-Self-Hosted-v3-Podman-Deployment-Guide.md): Complete guide for deploying Draftable API Self-Hosted v3 using Podman and Podman Compose as an alternative to Docker. ##### Migration - [Migrating from API Self-Hosted V2 to V3](https://help.draftable.com/hc/en-us/articles/52985002658841-Migrating-from-API-Self-Hosted-V2-to-V3.md): This guide covers migrating your existing Draftable API Self-Hosted V2 instance to V3. The migration process is designed for zero downtime, allowing both instances to run side-by-side during the transition. The entire process should take less than 30 minutes. ##### Instance Management - [API Self-Hosted v3 – User and viewer settings reference](https://help.draftable.com/hc/en-us/articles/API-Self-Hosted-v3-User-and-Viewer-Settings.md): Every user account on an API Self-Hosted v3 instance is configured through the built-in Django admin dashboard. This reference explains each setting on the user account page – plan limits, white labelling, comparison viewer controls, comparison options and colours – so you can tailor each account to… - [API Self-Hosted v3 – Usage, limits and entitlements](https://help.draftable.com/hc/en-us/articles/API-Self-Hosted-v3-Usage-Limits-and-Entitlements.md): What the usage figures on your instance mean, which limits are actually enforced on a self-hosted deployment, and what your licence does and does not control. - [Retrieve & export logs from API Self-Hosted v3](https://help.draftable.com/hc/en-us/articles/51117494938777-Retrieve-export-logs-from-API-Self-Hosted-v3.md): This article shows how to view and export logs for your **API Self-Hosted v3** stack from the console. It covers per-service log streaming, time-range filters, and simple export recipes for Linux/macOS and Windows. ##### API Reference - [API Self-Hosted v3 – Getting comparison results as JSON via the change-details endpoint](https://help.draftable.com/hc/en-us/articles/API-Self-Hosted-v3-Getting-Comparison-Results-as-a-JSON-via-the-Change-Details-Endpoint.md): The change-details endpoint allows you to retrieve comparison results from your API Self-Hosted v3 instance as a structured JSON response, including individual changes, style information, positional data, and a summary of all differences found. ### v2 #### Overview & Requirements ##### Getting Started - [New to Draftable API Self-hosted? Start here!](https://help.draftable.com/hc/en-us/articles/7132278452249-New-to-Draftable-API-Self-hosted-Start-here.md): Whether you are completely new to running dockerized containers, or you are an experienced user, this page will outline which articles will be most useful for you to begin with. ##### Requirements - [System requirements for a Self-hosted instance](https://help.draftable.com/hc/en-us/articles/6140740336665-System-requirements-for-a-Self-hosted-instance.md) - [Network requirements](https://help.draftable.com/hc/en-us/articles/12042585710489-Network-requirements.md): Draftable API Self-hosted container requires internet access to activate the license. #### Deployment ##### Deployment Guides - [Updating Draftable API Self Hosted](https://help.draftable.com/hc/en-us/articles/40971532147225-Updating-Draftable-API-Self-Hosted.md): Updating your Draftable API Self-Hosted instance means updating to use the latest image version which ensures access to the newest features, performance improvements, and security updates. This guide walks you through the steps to update your instance. - [Draftable Self-hosted instance first time configuration](https://help.draftable.com/hc/en-us/articles/8424839618457-Draftable-Self-hosted-instance-first-time-configuration.md): When you have first launched an instance, there is a first time configuration that is required to setup the administrator account for that instance. This article will detail a clear procedure for configuring your instance for the first time. - [Using docker-compose to launch instances](https://help.draftable.com/hc/en-us/articles/6140153331993-Using-docker-compose-to-launch-instances.md): Our recommendation is that users launch Draftable API Self-hosted containers via Docker Compose, as it is the most reliable and configurable method of container deployment. This article will guide you to the correct procedure to launch instances using docker-compose. ###### Cloud deployment guides - [API Self Hosted Deployment on Azure](https://help.draftable.com/hc/en-us/articles/33065329148313-API-Self-Hosted-Deployment-on-Azure.md): This article is intended for users who wish to deploy a Draftable API Self Hosted container via Microsoft Azure. The best-supported method of Self Hosted deployment via Azure is to host a Linux virtual machine, and then to configure that virtual machine to run the container. - [AWS copilot deployment guide for Draftable Self-hosted](https://help.draftable.com/hc/en-us/articles/5526134550809-AWS-copilot-deployment-guide-for-Draftable-Self-hosted.md): AWS Copilot is designed for both existing ECS users, and new ECS users who want to move beyond manual management of lower-level infrastructure, and instead just start thinking about their application and its lifecycle. In essence users can go from idea to implementation quickly, with the confidence… - [API Self-hosted AWS EC2 deployment guide](https://help.draftable.com/hc/en-us/articles/6142662952089-API-Self-hosted-AWS-EC2-deployment-guide.md): If you intend on using AWS EC2 to host your Draftable Self-hosted image, this guide provides a step by step process for this exact deployment. - [AWS load balancer configuration example for your EC2 instance](https://help.draftable.com/hc/en-us/articles/6142677946265-AWS-load-balancer-configuration-example-for-your-EC2-instance.md): A load balancer **serves as the single point of contact for clients**. The load balancer distributes incoming application traffic across multiple targets, such as EC2 instances, in multiple Availability Zones. This increases the availability of your application. ##### Migration to V3 - [Migrating from API Self-Hosted V2 to V3](https://help.draftable.com/hc/en-us/articles/52985002658841-Migrating-from-API-Self-Hosted-V2-to-V3.md): This guide covers migrating your existing Draftable API Self-Hosted V2 instance to V3. The migration process is designed for zero downtime, allowing both instances to run side-by-side during the transition. The entire process should take less than 30 minutes. #### Configuration ##### Security & Networking - [MFA configuration](https://help.draftable.com/hc/en-us/articles/10941649851801-MFA-configuration.md): Multi Factor Authentication (MFA) is a security method that is used to grant instance access to users only after they provide two sets of login credentials. The first is the user's password and the second is a code generated by an authentication app. - [Reverse proxy server configurations for API Self-hosted](https://help.draftable.com/hc/en-us/articles/6141903571609-Reverse-proxy-server-configurations-for-API-Self-hosted.md): A reverse proxy is a server that sits in front of web servers and forwards client (e.g. web browser) requests to those web servers. Reverse proxies are typically implemented to help increase security, performance, and reliability. - [CORS implementation within API Self-hosted](https://help.draftable.com/hc/en-us/articles/5526130052633-CORS-implementation-within-API-Self-hosted.md): This article is intended for users wanting to configure CORS (Cross-origin resource sharing) support to their API Self-hosted instance. - [SSL termination configuration](https://help.draftable.com/hc/en-us/articles/5526115029017-SSL-termination-configuration.md) - [Installing custom certificates onto your Self-hosted instance](https://help.draftable.com/hc/en-us/articles/5526003315353-Installing-custom-certificates-onto-your-Self-hosted-instance.md) ##### Docker & Parameters - [Understanding the docker-compose.yml file and parameters guide](https://help.draftable.com/hc/en-us/articles/6140653011865-Understanding-the-docker-compose-yml-file-and-parameters-guide.md) #### Instance Management ##### Users & Logs - [Creating new users](https://help.draftable.com/hc/en-us/articles/7132308389017-Creating-new-users.md): Creating new user accounts within a API Self Hosted instance is a quick process carried out by a administrator account of the Self Hosted instance. - [Retrieving logs for API Self-hosted](https://help.draftable.com/hc/en-us/articles/6142667920537-Retrieving-logs-for-API-Self-hosted.md): Draftable API Self-hosted, offers log retrieval for diagnostic purposes which can be downloaded as an archive from the administration interface. This feature is intended to be used to expedite support issues reported on your Self-hosted instance. - [Managing user settings](https://help.draftable.com/hc/en-us/articles/7132242748313-Managing-user-settings.md): User accounts within a API Self Hosted instance are managed within the Django backend, which is a user management tool local to your instance. There are many configurations that can be altered for your user accounts, and this article details the procedure of managing these settings. #### API Reference ##### API Documentation & SDKs - [API documentation](https://help.draftable.com/hc/en-us/articles/7132291227289-API-documentation.md): The Draftable API is complemented by detailed documentation which provides information on the many facets of the API and its endpoints. For the most up to date documentation, see below for further information. - [Getting Comparison Results as a JSON via the Change-Details Endpoint (API Self Hosted)](https://help.draftable.com/hc/en-us/articles/37873874456985-Getting-Comparison-Results-as-a-JSON-via-the-Change-Details-Endpoint-API-Self-Hosted.md): The change-details endpoint allows you to retrieve comparison results as a structured JSON response, including individual changes, style information, positional data, and a summary of all differences found. - [API client libraries](https://help.draftable.com/hc/en-us/articles/7132291518233-API-client-libraries.md): Draftable maintains several open-source client libraries, making it easy to use the API from C#/.NET, Java, Python, and Node.js. Each library is a thin wrapper around the API that handles making the requests, as well as authentication and signing. The libraries are fully documented in their READMEs… ## Draftable Partners ### Partner with Draftable #### - [Why partner with Draftable](https://help.draftable.com/hc/en-us/Draftable-Partner-articles/Why-partner-with-Draftable.md): Give your clients document comparison they can trust, and earn as you do. - [JourneyBee — the Draftable partner platform](https://help.draftable.com/hc/en-us/Draftable-Partner-articles/JourneyBee-Draftable-partner-platform.md): One place to register deals, track your pipeline, and grow with Draftable. - [JourneyBee walkthrough: an introduction and demonstration](https://help.draftable.com/hc/en-us/Draftable-Partner-articles/JourneyBee-walkthrough-video.md): A full guided tour of the Draftable partner platform, from signing in to registering deals and finding resources. ## OpenAPI Specs - [openapi](/api-reference/openapi.json) ## AsyncAPI Specs - [asyncapi](/docs-main/asyncapi.yaml) > The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages. ## Indexes - [Release Notes (48 pages)](https://help.draftable.com/_llms/release-notes.txt): Documentation for Release Notes. - [Draftable Legal (178 pages)](https://help.draftable.com/_llms/draftable-legal.txt): Documentation for Draftable Legal . This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.