Skip to content
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,13 @@ A **Finding Group** is a collection of findings that are scored in the same way
### Page Template
A **Page Template** lets you customize report background images and footers. You can set one **Page Template** as the default, and it will be applied globally unless overridden at the **Engagement** or **Report** level.

## Markdown placeholders
You can automatically insert client-specific information such as the client name, URL, e-mail, etc. in your reports, by inserting
`{Client<field>}` in the text. This is particularly useful for report templates.

For example, if you want to refer to the client in your executive summary, you can insert `{ClientName}` in the text. For a specific
list of fields you can insert, or to insert more, refer to [the markdown.py file](writehat/lib/markdown.py)
Finally, please note that you can also use the editor's 🔗 icon to select these placeholders (and more!).

## Writing Custom Report Components

Expand Down Expand Up @@ -262,6 +269,10 @@ $ systemctl start writehat
- More advanced table creator with CSV upload feature
- More granular permissions / ACLs (beyond just user + admin roles)

## Starting afresh
WriteHat stores your instance's data in the `/mongo` and `/mysql` directories. The easiest way to start from
scratch is to run `git clean -f -d`.


## Known Bugs / Limitations:
- Chrome or Chromium is the recommended browser. Others are untested and may experience bugs.
Expand Down