Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/modfin/securitytxt
Go service for rendering securitytxt page from environment variables
https://github.com/modfin/securitytxt
golang securitytxt
Last synced: about 1 month ago
JSON representation
Go service for rendering securitytxt page from environment variables
- Host: GitHub
- URL: https://github.com/modfin/securitytxt
- Owner: modfin
- License: mit
- Created: 2023-02-03T21:26:40.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-12T10:46:40.000Z (about 1 year ago)
- Last Synced: 2024-06-21T19:04:34.429Z (7 months ago)
- Topics: golang, securitytxt
- Language: Go
- Homepage:
- Size: 4.88 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: securitytxt.go
Awesome Lists containing this project
README
# Securitytxt service
> Reference:
> * https://securitytxt.org/
> * https://github.com/securitytxt/security-txt
> * https://www.rfc-editor.org/info/rfc9116
This is a small go service that produces a securitytxt file from environment variables and serving it through a http server
The purpose for the container is to deploy in a k8s, or similar, context and adding it to the ingress on one of the following paths
`/.well-known/security.txt` or `/security.txt`
## Example
```bash
docker run -i \
--env "CONTACT_URIS=mailto:[email protected] tel:+012-3456-789" \
--env "EXPIRES=$(date --date="+1 year" +%Y-%m-%d)" \
--publish "8080:8080" \
modfin/securitytxt:latest
```
## Environment variables
```
COMMENT (string)
EXPIRES (yyyy-mm-dd or RFC3999)
CONTACT_URIS ([]string, del " ")
ACKNOWLEDGMENT_URIS ([]string, del " ")
CANONICAL_URIS ([]string, del " ")
ENCRYPTION_URIS ([]string, del " ")
HIRING_URIS ([]string, del " ")
PREFERRED_LANGUAGES ([]string, del " ")
POLICY_URIS ([]string, del " ")
RAW_SECURITY_TXT (string, overrides all other values)
```