This commit is contained in:
WickedYoda committed 2025-02-24 18:43:54 -06:00
1 parent 94a6767dae
commit 5f93e778a0
3 files changed
+93 -19

No files matched your search

+42 -14
View File
@@ -1,21 +1,49 @@
# Security Policy
## Supported Versions
## 📌 Supported Versions
This repository is provided **as-is** without official support. However, contributions and reports of issues are welcome.
Use this section to tell people about which versions of your project are
currently being supported with security updates.
| Version | Status | Notes |
|---------|------------|-------|
| Latest | Actively Maintained | Open for contributions |
| Older | No Support | Use at your own risk |
| Version | Supported |
| ------- | ------------------ |
| 5.1.x | :white_check_mark: |
| 5.0.x | :x: |
| 4.0.x | :white_check_mark: |
| < 4.0 | :x: |
---
## Reporting a Vulnerability
## 🔍 Reporting Security Issues
If you find a **security vulnerability**, please **DO NOT** open a public issue. Instead, follow these steps:
Use this section to tell people how to report a vulnerability.
1. **Contact Me Privately**:
- Email: **[your-email@example.com]** (replace with actual contact if needed)
- Direct message on **GitHub**
2. **Include in Your Report**:
- A **detailed description** of the issue.
- Steps to **reproduce** it.
- Any **possible fixes** you suggest.
Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
3. **Response Time**:
- Issues will be reviewed **within 7 days**.
- If confirmed, a fix will be worked on and released as soon as possible.
---
## 🔐 Security Best Practices
Although this repository contains setup scripts, users are responsible for ensuring **secure usage**. Follow these guidelines:
✅ **Keep your system up to date**
✅ **Use strong passwords & enable MFA where possible**
✅ **Review scripts before running them**
✅ **Use Docker safely with minimal privileges**
✅ **Do not expose sensitive configurations**
---
## ❗ Disclaimer
This repository is licensed under **CC-BY-NC 4.0** and is provided **without warranty**. Use at your own risk. The repository owner is **not responsible for any damage** resulting from its use.
---
## 🔗 References
- [Creative Commons Attribution-NonCommercial 4.0](https://creativecommons.org/licenses/by-nc/4.0/)
- [GitHub Security Best Practices](https://docs.github.com/en/code-security)