Jatin K MalikandGitHub
03d55a989f
* docs: update all documentation for whisper.cpp as default engine Comprehensive documentation update highlighting whisper.cpp as the new default speech recognition engine: README.md: - Added 'Major Change: whisper.cpp is Now Default!' section - Updated Features to highlight whisper.cpp and Vulkan GPU support - Updated Quick Install section with engine choices - Changed default engine from whisper to whisper_cpp in examples - Updated configuration examples - Updated roadmap to mark whisper.cpp as complete docs/INSTALL.md: - Added whisper.cpp section with performance benefits - Updated installation options (--engine flag) - Added GPU support matrix and Vulkan detection info - Added installation time comparison table - Updated system requirements (lower disk space for whisper.cpp) docs/USER_GUIDE.md: - Added comprehensive 'Choosing Your Engine' section - Added GPU acceleration information - Updated tips to mention whisper.cpp benefits - Added model size recommendations web/src/app/page.tsx: - Updated hero to mention whisper.cpp (C++ optimized, Vulkan support) - Changed installation time from ~5-10 min to ~1-2 min - Updated Features section to mention Vulkan GPU support - Added whisper.cpp as default engine card (3-column layout) - Updated installation commands (--engine flags) - Updated FAQ about switching engines This ensures all documentation reflects whisper.cpp as the new default and highlights its major benefits: 10x faster install, universal GPU support, and C++ optimized performance. * chore(release): prepare v0.6.0-beta This release brings whisper.cpp as the new default speech recognition engine: Version Updates: - Bump version from 0.5.0-beta to 0.6.0-beta - Update src/vocalinux/version.py - Update web/package.json Documentation Updates: - README.md: Update all v0.5.0-beta references to v0.6.0-beta - docs/INSTALL.md: Update version references and installation commands - docs/UPDATE.md: Add new 'What's New' section highlighting whisper.cpp - SECURITY.md: Update supported versions table (0.6.x now supported) Website Updates: - web/src/app/layout.tsx: Update softwareVersion to 0.6.0-beta Release Highlights: - whisper.cpp is now the default engine (10x faster install!) - Universal GPU support via Vulkan (AMD, Intel, NVIDIA) - C++ optimized inference with multi-threading - ~1-2 minute installation vs ~5-10 minutes before Testing: - All 472 tests passing - Black formatting clean - Flake8 linting clean - isort import ordering clean * ui(website): improve hero section layout * docs(readme): remove duplicate What's New section
96 lines
2.8 KiB
Markdown
96 lines
2.8 KiB
Markdown
# Security Policy
|
|
|
|
## Supported Versions
|
|
|
|
| Version | Supported |
|
|
| ------- | ------------------ |
|
|
| 0.6.x | :white_check_mark: |
|
|
| 0.5.x | :x: |
|
|
| 0.4.x | :x: |
|
|
| < 0.4 | :x: |
|
|
|
|
## Reporting a Vulnerability
|
|
|
|
We take security seriously. If you discover a security vulnerability within Vocalinux, please follow these steps:
|
|
|
|
### Do NOT
|
|
|
|
- Open a public GitHub issue for security vulnerabilities
|
|
- Disclose the vulnerability publicly before it's fixed
|
|
|
|
### Do
|
|
|
|
1. **Email the maintainer directly**: Send an email to jatinkrmalik@gmail.com with:
|
|
- A clear description of the vulnerability
|
|
- Steps to reproduce the issue
|
|
- Potential impact assessment
|
|
- Any suggested fixes (optional)
|
|
|
|
2. **Use the subject line**: "Vocalinux Security Vulnerability Report"
|
|
|
|
3. **Wait for acknowledgment**: You should receive a response within 48 hours
|
|
|
|
### What to Expect
|
|
|
|
1. **Acknowledgment**: We'll confirm receipt within 48 hours
|
|
2. **Assessment**: We'll evaluate the severity and impact
|
|
3. **Timeline**: We'll provide an estimated fix timeline
|
|
4. **Fix**: We'll work on a fix and coordinate disclosure
|
|
5. **Credit**: If desired, we'll credit you in the release notes
|
|
|
|
## Security Considerations
|
|
|
|
### Privacy
|
|
|
|
Vocalinux is designed with privacy in mind:
|
|
|
|
- **Offline by default**: whisper.cpp (default), Whisper, and VOSK engines all work completely offline
|
|
- **Local processing**: All speech recognition happens on your device
|
|
- **No data collection**: We don't collect or transmit your voice data
|
|
- **No telemetry**: We don't track usage or behavior
|
|
|
|
### whisper.cpp (Default Engine)
|
|
|
|
whisper.cpp is the default speech recognition engine:
|
|
- High-performance C++ implementation
|
|
- Processes completely locally on your machine
|
|
- Models are downloaded once and cached locally
|
|
- No audio data is sent to external servers
|
|
- Supports Vulkan GPU acceleration for AMD, Intel, and NVIDIA GPUs
|
|
|
|
### Whisper AI (OpenAI)
|
|
|
|
OpenAI's Whisper is also available as an alternative:
|
|
- PyTorch-based implementation
|
|
- Processes locally on your machine
|
|
- Models are downloaded once and cached locally
|
|
- No audio data is sent to external servers
|
|
|
|
### File Permissions
|
|
|
|
The application stores data in:
|
|
- `~/.config/vocalinux/` - Configuration (mode 700)
|
|
- `~/.local/share/vocalinux/` - Data and models (mode 700)
|
|
|
|
### Known Limitations
|
|
|
|
1. **Text injection**: Uses xdotool/wtype which may have implications for input monitoring
|
|
2. **Keyboard shortcuts**: Global keyboard hooks require appropriate permissions
|
|
3. **Virtual environments**: Running in a venv provides some isolation
|
|
|
|
## Updates
|
|
|
|
Keep your installation updated to receive security fixes:
|
|
|
|
```bash
|
|
cd vocalinux
|
|
git pull origin main
|
|
pip install --upgrade -e .
|
|
```
|
|
|
|
## Contact
|
|
|
|
For security concerns: jatinkrmalik@gmail.com
|
|
|
|
For general issues: https://github.com/jatinkrmalik/vocalinux/issues
|