https://github.com/edoverflow/security-template
A static website template for security pages.
https://github.com/edoverflow/security-template
Last synced: 4 months ago
JSON representation
A static website template for security pages.
- Host: GitHub
- URL: https://github.com/edoverflow/security-template
- Owner: EdOverflow
- License: mit
- Created: 2017-11-08T17:30:54.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-23T08:58:33.000Z (10 months ago)
- Last Synced: 2025-01-06T18:41:52.711Z (6 months ago)
- Language: HTML
- Homepage:
- Size: 127 KB
- Stars: 50
- Watchers: 5
- Forks: 23
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Project
_SecurityTemplate_ is a static website template for security pages, powered by Jekyll. It's easy to get started. Clone this repo, edit the configuration files and content to your liking, and publish with [GitHub Pages](https://pages.github.com) or on your own server platform.
You can [set up a local environment](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/) to test your _SecurityTemplate_ static site, and [push to GitHub](https://help.github.com/articles/using-jekyll-as-a-static-site-generator-with-github-pages/) if desired.
This project is a rapidly evolving work in progress. We value [contributions](https://github.com/EdOverflow/security-template/blob/master/CONTRIBUTING.md) from the public.
# Structure
The template directory structure is as follows:
```
.
├── 404.html # 404 page.
├── advisories.md # Security advisories list.
├── assets # Page assets.
│ ├── css
│ │ └── styles.css
│ └── images
│ └── icon.png
├── _config.yml # Config file with all your variables.
├── _drafts
├── Gemfile
├── Gemfile.lock
├── hof.md # Hall of fame page.
├── _includes
│ └── advisory-list.html
├── index.md # Security policy.
├── _layouts
│ ├── default.html
│ └── post.html
├── LICENSE
├── _posts
│ └── 2017-07-22-cve-2017-0914.md # Example security advisory.
├── README.md
└── report.md
```
## `config.yml`
* `company_name` — replace this with your organization name
* `email` — replace this with your security contact address
* `bugcrowd_id` — replace this with your [Bugcrowd ID](https://docs.bugcrowd.com/v1.0/docs/embedded-submission-form), if applicable
* `hackerone_url` and `bugcrowd_url` — the /report URL will redirect to one of these, if specified.
## `index.md`
The index file is where your security policy lives. To learn more about writing good security policies, please refer to https://support.hackerone.com/hc/en-us/articles/205624665-How-do-we-write-a-good-policy-.
## `advisories.md`
This is where you can list your security advisories. The list is updated every time you add a security advisory to the `_posts` folder.
## `report.md`
This file should contain contact information for security researchers to use when reporting a security vulnerability. If a HackerOne or Bugcrowd URL is specified in `config.yml`, users will be redirected automatically. You can also use an embedded Bugcrowd submission form. Just uncomment the form, and add your Bugcrowd embed token under `bugcrowd_id` in `_config.yml`.
## `hof.md`
This is your security acknowledgements page. List the details of security researchers that reported valid security issues (and wish to be listed publicly).
## `.well-known/security.txt`
`security-template` contains a security.txt template file. _security.txt_ defines a standard to help organizations define the process for security researchers to safely disclose vulnerabilities via a simple text file. For more on this, please refer to https://securitytxt.org/.
# Contributing
We welcome contributions from the public.
### Using the issue tracker 💡
The issue tracker is the preferred channel for bug reports and features requests.
### Issues and labels 🏷
The bug tracker utilizes several labels to help organize and identify issues.
### Guidelines for bug reports 🐛
Use the GitHub issue search — check if the issue has already been reported.