# Ghostwriter Documentation

## Docs

- [Form Layouts & Design](https://www.ghostwriter.wiki/coding-style-guide/form-layouts-and-design.md): Creation and layout of forms
- [Custom Layout Objects](https://www.ghostwriter.wiki/coding-style-guide/form-layouts-and-design/custom-layout-objects.md): The Ghostwriter project's custom additions to django-crispy-forms
- [Formset Layout & Design](https://www.ghostwriter.wiki/coding-style-guide/form-layouts-and-design/formset-layout-and-design.md): Creation and layout of inline formsets
- [Overview](https://www.ghostwriter.wiki/coding-style-guide/style-guide.md): Coding style guide for the Ghostwriter code base
- [Overview](https://www.ghostwriter.wiki/configuring-global-settings/configuring-apis.md)
- [Configuring Cloud Services](https://www.ghostwriter.wiki/configuring-global-settings/configuring-apis/configuring-cloud-services.md): Enabling cloud service APIs
- [Configuring Namecheap](https://www.ghostwriter.wiki/configuring-global-settings/configuring-apis/configuring-namecheap.md): Enabling the Namecheap API
- [Configuring Slack](https://www.ghostwriter.wiki/configuring-global-settings/configuring-apis/configuring-slack.md): Enabling Slack WebHooks for notifications
- [Configuring VirusTotal](https://www.ghostwriter.wiki/configuring-global-settings/configuring-apis/configuring-virustotal.md): Enabling the VirusTotal API
- [Configuring Extra Fields](https://www.ghostwriter.wiki/configuring-global-settings/configuring-extra-fields.md)
- [Configuring Global Report Options](https://www.ghostwriter.wiki/configuring-global-settings/configuring-global-report-options.md): Configuring report styles
- [Configuring the Announcement Banner](https://www.ghostwriter.wiki/configuring-global-settings/configuring-the-announcement-banner.md): Configuring an announcement banner for Ghostwriter.
- [Introduction to Command Center](https://www.ghostwriter.wiki/configuring-global-settings/introduction-to-command-center.md): Configuring global variables for Ghostwriter and report generation
- [Personalizing Company Information](https://www.ghostwriter.wiki/configuring-global-settings/personalizing-company-information.md): Configuring your company's information for reporting
- [Contributing to the Project](https://www.ghostwriter.wiki/development/contributing-to-the-project.md): How to go about contributing code to the project
- [Pre-Release Checklist](https://www.ghostwriter.wiki/development/contributing-to-the-project/pre-release-checklist.md): Step-by-step instructions for preparing a release or PR
- [Database Models](https://www.ghostwriter.wiki/development/database-models.md): UML diagrams for Ghostwriter database models
- [API Models](https://www.ghostwriter.wiki/development/database-models/api-models.md)
- [Configuration Models](https://www.ghostwriter.wiki/development/database-models/configuration-models.md): The CommandCenter application contains models based on a custom singleton model class. The models manage global configurations and only allow one entry per model.
- [Home & User Models](https://www.ghostwriter.wiki/development/database-models/home-models.md)
- [Infrastructure Models](https://www.ghostwriter.wiki/development/database-models/infrastructure-models.md)
- [Oplog Models](https://www.ghostwriter.wiki/development/database-models/oplog-models.md)
- [Reporting Models](https://www.ghostwriter.wiki/development/database-models/reporting-models.md)
- [Client & Project Models](https://www.ghostwriter.wiki/development/database-models/rolodex-models.md): The client and project management application, Rolodex, and related models track everything related to a client and their projects.
- [Expected Services & Processes](https://www.ghostwriter.wiki/development/expected-services-and-processes.md)
- [Overview](https://www.ghostwriter.wiki/development/modifying-code.md): Modifying and then deploying code changes
- [Modifying Environment Variables](https://www.ghostwriter.wiki/development/modifying-code/modifying-environment-variables.md): Making changes to the environment variables inside the containers
- [Overview](https://www.ghostwriter.wiki/development/stack-overview.md)
- [Behind the Scenes](https://www.ghostwriter.wiki/development/stack-overview/behind-the-scenes.md): A look at the thought process behind Ghostwriter's development
- [Testing Code](https://www.ghostwriter.wiki/development/testing-code.md): Developing and running unit tests
- [Access, Authentication, & Session Controls](https://www.ghostwriter.wiki/features/access-authentication-and-session-controls.md): Everything that manages how users authenticate, what they can access, and how their web sessions work
- [Multi-Factor Authentication](https://www.ghostwriter.wiki/features/access-authentication-and-session-controls/multi-factor-authentication.md): Using Ghostwriter's support for TOTP and WebAuthn MFA
- [Role-Based Access Controls](https://www.ghostwriter.wiki/features/access-authentication-and-session-controls/role-based-access-controls.md)
- [Session Management](https://www.ghostwriter.wiki/features/access-authentication-and-session-controls/session-management.md): Managing user web sessions
- [Single Sign-On](https://www.ghostwriter.wiki/features/access-authentication-and-session-controls/single-sign-on.md): Authentication and account creation via an external SSO provider
- [Overview](https://www.ghostwriter.wiki/features/background-tasks.md): Configuring and scheduling background tasks
- [Prebuilt Tasks](https://www.ghostwriter.wiki/features/background-tasks/prebuilt-tasks.md)
- [Scheduling Tasks](https://www.ghostwriter.wiki/features/background-tasks/scheduled-tasks.md): Configuring tasks to run repeatedly on a schedule
- [Overview](https://www.ghostwriter.wiki/features/bloodhound-integration-overview.md): Connecting BloodHound and Ghostwriter for enhanced reporting
- [Accessing BloodHound Data in Reports](https://www.ghostwriter.wiki/features/bloodhound-integration/bloodhound-data-in-reports.md): How to access the data in your report templates
- [Configuring BloodHound](https://www.ghostwriter.wiki/features/bloodhound-integration/configuring-bloodhound.md): How to integrate your BloodHound server(s) with Ghostwriter
- [Differences Between BHCE and BHE](https://www.ghostwriter.wiki/features/bloodhound-integration/differences-between-bhce-and-bhe.md): Data differences between Community Edition and Enterprise
- [Viewing & Managing BloodHound Data](https://www.ghostwriter.wiki/features/bloodhound-integration/managing-bloodhound-data.md): How to view and manage your BloodHound data
- [Overview](https://www.ghostwriter.wiki/features/client-and-project-management.md)
- [Client Dashboard](https://www.ghostwriter.wiki/features/client-and-project-management/client-dashboard.md)
- [Overview](https://www.ghostwriter.wiki/features/client-and-project-management/project-dashboard.md)
- [Deconfliction Tracking](https://www.ghostwriter.wiki/features/client-and-project-management/project-dashboard/deconfliction-tracking.md): Tracking deconfliction events during assessments
- [Objective Tracking](https://www.ghostwriter.wiki/features/client-and-project-management/project-dashboard/objective-tracking.md): Tracking the project's objectives, tasks, and status
- [Project Points of Contact & Assignments](https://www.ghostwriter.wiki/features/client-and-project-management/project-dashboard/project-points-of-contact-and-assignments.md): Tracking team assignments and project contacts
- [Scope Tracking](https://www.ghostwriter.wiki/features/client-and-project-management/project-dashboard/scope-tracking.md): Tracking hostnames and IP addresses in-scope for the project
- [White Card Tracking](https://www.ghostwriter.wiki/features/client-and-project-management/project-dashboard/white-card-tracking.md): Tracking white cards during assessments
- [Overview](https://www.ghostwriter.wiki/features/findings-library.md): Managing finding templates with the Finding Library
- [Template Values for Findings](https://www.ghostwriter.wiki/features/findings-library/finding-keywords.md): Using template values to format findings
- [Populating the Findings Library](https://www.ghostwriter.wiki/features/findings-library/populating-the-findings-library.md): Adding findings to the library
- [Authentication](https://www.ghostwriter.wiki/features/graphql-api/authentication.md)
- [Common API Actions](https://www.ghostwriter.wiki/features/graphql-api/common-api-actions.md): Description and explanation of common API actions
- [Overview](https://www.ghostwriter.wiki/features/graphql-api/graphql-api.md)
- [GraphQL Usage Examples](https://www.ghostwriter.wiki/features/graphql-api/graphql-usage-examples.md): Examples of automating tasks and integrating external tools with Ghostwriter via the GraphQL API
- [Integrating with BloodHound for Reporting](https://www.ghostwriter.wiki/features/graphql-api/graphql-usage-examples/integrating-with-bloodhound-for-reporting.md): Pass BloodHound data to Ghostwriter for inclusion in your reports
- [Recording Cloud Server Deployments](https://www.ghostwriter.wiki/features/graphql-api/graphql-usage-examples/recording-cloud-server-deployments.md): Recording cloud server deployments in Ghostwriter with GraphQL
- [Using the Hasura Console](https://www.ghostwriter.wiki/features/graphql-api/using-the-hasura-console.md): How to enable and use the Hasura Console to access the GraphQL API
- [Health Monitoring](https://www.ghostwriter.wiki/features/health-monitoring.md): How to monitor the health of Ghostwriter services
- [Infrastructure Management](https://www.ghostwriter.wiki/features/infrastructure-management.md)
- [Domains Management](https://www.ghostwriter.wiki/features/infrastructure-management/domains-management.md): Managing domains with the Domain Library
- [Domain Checkout](https://www.ghostwriter.wiki/features/infrastructure-management/domains-management/domain-checkout-1.md): Checking-out a domain for a project
- [Monitoring Domains](https://www.ghostwriter.wiki/features/infrastructure-management/domains-management/monitoring-domains.md): Performing health checkups on domain names
- [Populating the Domain Library](https://www.ghostwriter.wiki/features/infrastructure-management/domains-management/populating-the-domain-library.md): Adding domains to the library
- [Server Management](https://www.ghostwriter.wiki/features/infrastructure-management/server-management.md): Managing servers with the Server Library
- [Monitoring Servers](https://www.ghostwriter.wiki/features/infrastructure-management/server-management/monitoring-servers.md): Performing health checkups on servers
- [Populating the Server Library](https://www.ghostwriter.wiki/features/infrastructure-management/server-management/populating-the-server-library.md): Adding servers to the library
- [Server Checkout](https://www.ghostwriter.wiki/features/infrastructure-management/server-management/server-management.md): Checking-out a server for a project
- [Observations Library](https://www.ghostwriter.wiki/features/observations-library.md)
- [Overview](https://www.ghostwriter.wiki/features/operation-logs.md)
- [Attaching Terminal Recordings to Log Entries](https://www.ghostwriter.wiki/features/operation-logs/attaching-terminal-recordings.md): Document terminal activities with Asciinema recordings
- [Interacting with the Operation Log Table](https://www.ghostwriter.wiki/features/operation-logs/create-a-new-entry.md): Using the live activity log
- [Creating a New Operation Log](https://www.ghostwriter.wiki/features/operation-logs/creating-a-new-oplog.md): Creating a new log
- [Exporting / Importing Operation Logs](https://www.ghostwriter.wiki/features/operation-logs/exporting-importing-oplogs.md): Exporting and importing activity log data
- [Generating Attack Path Narrative Outlines](https://www.ghostwriter.wiki/features/operation-logs/generating-narrative-outlines.md): Build a narrative outline from operation log entries
- [Linking Evidence to Log Entries](https://www.ghostwriter.wiki/features/operation-logs/linking-evidence-to-entries.md): Associate findings and artifacts with operation log activities
- [Setting up Automated Logging](https://www.ghostwriter.wiki/features/operation-logs/setting-up-automated-logging.md): Configuring the API endpoint for automatic activity logging
- [Reporting](https://www.ghostwriter.wiki/features/reporting.md)
- [Overview](https://www.ghostwriter.wiki/features/reporting/collaborative-editing.md): Introducing Ghostwriter's collaborative editor
- [Editor Features](https://www.ghostwriter.wiki/features/reporting/collaborative-editor/editor-features.md): Features of the collaborative editor
- [Jinja2 Tips & Tricks](https://www.ghostwriter.wiki/features/reporting/jinja2-tips-and-tricks.md): Examples of simple and advanced Jinja2 code for reporting
- [Report Templates](https://www.ghostwriter.wiki/features/reporting/report-templates.md): Managing report templates for Word and PowerPoint
- [Report Template Linting](https://www.ghostwriter.wiki/features/reporting/report-templates/report-template-linting.md): Introducing the report template linter and how to read the results
- [Troubleshooting Word Templates](https://www.ghostwriter.wiki/features/reporting/report-templates/troubleshooting-word-templates.md): Tips for troubleshooting templates reporting issues inside Word
- [Word Template Styles](https://www.ghostwriter.wiki/features/reporting/report-templates/word-template-styles.md): Using Ghostwriter's Word styles
- [Word Template Variables & Filters](https://www.ghostwriter.wiki/features/reporting/report-templates/word-template-variables.md): Introducing the Word template variables
- [Overview](https://www.ghostwriter.wiki/features/reporting/report-types.md): Introduction to the built-in report types
- [Excel Spreadsheet Customization](https://www.ghostwriter.wiki/features/reporting/report-types/excel-spreadsheet-customization.md): Customizing Excel spreadsheet generation
- [PowerPoint Deck Customization](https://www.ghostwriter.wiki/features/reporting/report-types/powerpoint-deck-customization.md): Customizing PowerPoint slide deck generation
- [Word Document Customization](https://www.ghostwriter.wiki/features/reporting/report-types/word-document-customization.md): Customizing Word document generation
- [Templating and Rich Text Fields](https://www.ghostwriter.wiki/features/reporting/templating-and-rich-text-fields.md)
- [Overview](https://www.ghostwriter.wiki/getting-help/faq.md)
- [Reporting a Problem](https://www.ghostwriter.wiki/getting-help/getting-help-with-a-problem.md): How to report a problem or get support
- [Reporting a Security Issue](https://www.ghostwriter.wiki/getting-help/reporting-a-security-issue.md): How to report vulnerabilities
- [Managing the Server with Ghostwriter CLI](https://www.ghostwriter.wiki/getting-started/managing-the-server-with-ghostwriter-cli.md): How to use Ghostwriter CLI to monitor and manage your Ghostwriter installation
- [Creating and Managing Backups](https://www.ghostwriter.wiki/getting-started/managing-the-server-with-ghostwriter-cli/creating-and-managing-backups.md)
- [Managing Logon Sessions](https://www.ghostwriter.wiki/getting-started/managing-the-server-with-ghostwriter-cli/managing-logon-sessions.md): Managing cookie age and logon session expirations
- [Quickstart](https://www.ghostwriter.wiki/getting-started/quickstart.md)
- [Updating Ghostwriter](https://www.ghostwriter.wiki/getting-started/updating-ghostwriter.md)
- [Welcome to Ghostwriter](https://www.ghostwriter.wiki/home.md): Introducing the SpecterOps project management and reporting platform
- [The Workflow](https://www.ghostwriter.wiki/workflow/basic-usage.md): Understanding the basic workflow of Ghostwriter
- [Finding Edit & Review Workflow](https://www.ghostwriter.wiki/workflow/basic-usage/finding-review-workflow.md)

## Optional

- [GitHub](https://github.com/GhostManager/Ghostwriter)
- [Community](https://join.slack.com/t/bloodhoundhq/shared_invite/zt-1tgq6ojd2-ixpx5nz9Wjtbhc3i8AVAWw)