-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add: Development setup docs and additional GitHub files
- Loading branch information
1 parent
e7b7c99
commit 7de4137
Showing
3 changed files
with
116 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Auto detect text files and perform LF normalization | ||
* text=auto | ||
|
||
# PowerShell files | ||
*.ps1 text eol=crlf | ||
*.psm1 text eol=crlf | ||
*.psd1 text eol=crlf | ||
|
||
# Batch files | ||
*.cmd text eol=crlf | ||
*.bat text eol=crlf | ||
|
||
# Documentation | ||
*.md text | ||
*.txt text | ||
*.yml text | ||
*.yaml text |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# Security Policy | ||
|
||
## Supported Versions | ||
|
||
This project is currently under active development. We provide security updates for the following versions: | ||
|
||
| Version | Supported | | ||
| ------- | ------------------ | | ||
| 1.x.x | :white_check_mark: | | ||
|
||
## Reporting a Vulnerability | ||
|
||
If you discover a security vulnerability within this project, please follow these steps: | ||
|
||
1. **Do Not** open a public issue | ||
2. Send a private email to [your-email@example.com] (replace with your email) | ||
3. Include: | ||
- A description of the vulnerability | ||
- Steps to reproduce | ||
- Potential impact | ||
- Suggested fix (if any) | ||
|
||
You can expect: | ||
- Acknowledgment of your report within 48 hours | ||
- Regular updates on the progress | ||
- Credit in the security advisory (unless you prefer to remain anonymous) | ||
|
||
## Security Best Practices | ||
|
||
When using this utility: | ||
|
||
1. **Run with Appropriate Permissions** | ||
- Use minimal required permissions | ||
- Avoid running as root/admin unless necessary | ||
|
||
2. **Environment Security** | ||
- Keep Docker up to date | ||
- Keep PowerShell up to date | ||
- Use latest Windows security updates | ||
|
||
3. **Script Verification** | ||
- Always verify script signatures | ||
- Download only from official repository | ||
- Check script contents before execution | ||
|
||
## Security Features | ||
|
||
This utility includes several security measures: | ||
|
||
1. **Safe Container Shutdown** | ||
- Graceful shutdown to prevent data corruption | ||
- Proper cleanup of resources | ||
|
||
2. **Error Handling** | ||
- Secure error messages | ||
- No sensitive information in logs | ||
- Proper exit codes | ||
|
||
## Audit Logging | ||
|
||
The script provides basic logging of shutdown operations. Consider enabling Docker's audit logging for additional security monitoring. |