https://github.com/hahwul/jekyll-securitytxt

Jekyll plugin for security.txt
https://github.com/hahwul/jekyll-securitytxt

jekyll jekyll-plugin securitytxt

Last synced: 3 months ago
JSON representation

Jekyll plugin for security.txt

• Host: GitHub
• URL: https://github.com/hahwul/jekyll-securitytxt
• Owner: hahwul
• Created: 2024-02-18T15:59:12.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-07-18T16:04:09.000Z (7 months ago)
• Last Synced: 2024-10-25T01:32:11.087Z (3 months ago)
• Topics: jekyll, jekyll-plugin, securitytxt
• Language: Ruby
• Homepage: https://rubygems.org/gems/jekyll-securitytxt
• Size: 16.6 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# jekyll-securitytxt

Jekyll plugin for [security.txt](https://www.rfc-editor.org/rfc/rfc9116)[^1]

[^1]: RFC9116

## Installation

```ruby

group :jekyll_plugins do

  # ...

  gem "jekyll-securitytxt"

end

```

## Usage

```yaml

# in _config.yml

security_txt:

  comment: If you find any security issues on this site, please contact me!

  contact: 

  - mailto:

  - https://YOUR_DOMAIN/CONTACT

  hiring:

  - https://URL1

  - https://URL2

  preferred_languages: "ko, en"

```

If you need a custom message? 

```yaml

security_txt:

  custom_message: |

      If you would like to report a security issue you may report it to us via bugbounty platform

      Contact: https://

```

## Supported

```yaml

security_txt:

  comment:

  contact:

  expires:

  encryption:

  preferred_languages:

  acknowledgments:

  policy:

  hiring:

  csaf:

  canonical:

  custom_message:

```

> [!TIP]

> See here for information on the column. https://securitytxt.org*