Ghostwriter is a Django project written in Python 3.8 and is designed to be used by a team of operators. The platform is made up of several Django apps that own different roles but work together.
Check-out the introductory blogpost: Introducing Ghostwriter
This blogpost discusses the design and intent behind Ghostwriter: Introducing Ghostwriter: Part 2
The Ghostwriter Wiki contains everything you need to know to use or customize Ghostwriter:
The wiki covers everything from installation and setup information for first time users to database schemas, the project's code style guide, and how to expand or customie parts of the project to fit your needs.
The quickest way to get help is Slack. The BloodHound Slack Team has a #ghostwriter channel for discussing this project and requesting assistance. There is also a #reporting channel for discussing various topics related to writing and managing reports and findings.
You can submit an issue. If you do, please use the issue template and provide as much information as possible.
Before submitting an issue, review the Ghostwriter Wiki. Many of the common issues new users encounter stem from missing a step (like loading the seed data to prep the database) or an issue with Docker on their host system.
Contributing to the Project
Please open issues or submit pull requests! The project team welcomes feedback, new ideas, and external contributions. Before submitting a PR, please check open and closed issues for any previous related discussion. Also, the submitted code must follow the Code Style Guide to be accepted.
We only ask that you limit PR submissions to those that fix a bug, enhance an existing feature, or add something new.
The following people have contributed much to this project:
These folks kindly submitted feedback and PRs to fix bugs and enhance existing features. Thank you!
Ghostwriter's continuous development would not be possible without SpecterOps's commitment to transparency and support for open-source development.
GitBook supports this project through its hosting of the wiki and granting the Ghostwriter team access to their GitBook Community tier as an open-source project.