Skip to content

Commit f49c070

Browse files
committed
Convert CHANGELOG.md to AsciiDoc
1 parent cd6a432 commit f49c070

1 file changed

Lines changed: 135 additions & 0 deletions

File tree

CHANGELOG.adoc

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
// SPDX-License-Identifier: AGPL-3.0-or-later
2+
= Changelog
3+
4+
All notable changes to Qubes SDP will be documented in this file.
5+
6+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
7+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
8+
9+
== [1.0.0] - 2024-11-22
10+
11+
=== Added
12+
13+
==== Core System
14+
- Simple setup script (`qubes-setup.sh`) for basic topology
15+
- Advanced setup script (`qubes-setup-advanced.sh`) with full configuration
16+
- Comprehensive configuration file (`qubes-config.conf`)
17+
- Makefile (`Makefile.qubes`) for automation
18+
- Salt Stack configuration for declarative setup
19+
20+
==== Qubes
21+
- Work qube with restricted firewall (HTTP/HTTPS/DNS only)
22+
- Vault qube (air-gapped, no network)
23+
- Anon qube (Tor/Whonix integration)
24+
- Untrusted qube (DisposableVM template)
25+
- Optional VPN qube (ProxyVM)
26+
- Optional USB qube (device management)
27+
28+
==== Features
29+
- Topology presets (journalist, developer, researcher, teacher, pentester)
30+
- Interactive setup wizard
31+
- Dry-run mode for testing
32+
- Comprehensive logging
33+
- Rollback mechanism
34+
- Progress indicators
35+
- Health checks
36+
- Split-GPG automation
37+
- Split-SSH automation
38+
- Qrexec policy generation
39+
- Firewall rule automation
40+
- Automated backups with cron
41+
- Template update automation
42+
43+
==== Tools
44+
- `qubes-status.sh` - Status dashboard
45+
- `qubes-dashboard.sh` - Interactive real-time monitor
46+
- `qubes-firewall-analyzer.sh` - Firewall analysis
47+
- `qubes-template-manager.sh` - Template management
48+
- `qubes-backup-validator.sh` - Backup verification
49+
- `qubes-restore.sh` - Disaster recovery
50+
- `qubes-policy-generator.sh` - Qrexec policy management
51+
52+
==== Documentation
53+
- Comprehensive README with architecture diagrams
54+
- QUICKSTART guide for rapid deployment
55+
- CONTRIBUTING guidelines
56+
- Complete wiki system with 10+ pages:
57+
- Getting Started
58+
- Installation Guide
59+
- Configuration Guide
60+
- Security Guide
61+
- Topology Presets
62+
- Split-GPG Guide
63+
- Split-SSH Guide
64+
- Backup & Restore Guide
65+
- Troubleshooting
66+
- FAQ
67+
- Example configurations (journalist, developer, minimal)
68+
- API documentation
69+
- Tool documentation
70+
71+
==== Testing
72+
- Syntax tests for all scripts
73+
- Unit tests for components
74+
- Integration tests for system interactions
75+
- Security tests for vulnerabilities
76+
- Automated test runner
77+
78+
==== Wiki System
79+
- Markdown to HTML builder
80+
- Professional responsive design
81+
- Interactive features (TOC, copy buttons)
82+
- Search functionality
83+
- Mobile-friendly layout
84+
85+
=== Security
86+
- Air-gapped vault enforced
87+
- Default-deny firewall policies
88+
- Minimal template usage
89+
- DisposableVM for risky content
90+
- Split-GPG/SSH key isolation
91+
- Comprehensive security testing
92+
- Input validation throughout
93+
- No hardcoded credentials
94+
95+
=== Documentation
96+
- 10+ wiki pages with 4000+ lines
97+
- README with feature overview
98+
- QUICKSTART for rapid onboarding
99+
- Example configurations
100+
- Troubleshooting guides
101+
- FAQ with 50+ questions
102+
- Tool documentation
103+
- API reference
104+
105+
== [Unreleased]
106+
107+
=== Planned
108+
- Web-based configuration UI
109+
- Additional topology presets
110+
- Automated security auditing
111+
- Performance optimization tools
112+
- Multi-language support
113+
- Video tutorials
114+
- Plugin system enhancements
115+
- CI/CD pipeline integration
116+
- Docker-based testing environment
117+
118+
== Version History
119+
120+
=== [1.0.0] - 2024-11-22
121+
- Initial release
122+
- Complete feature set
123+
- Full documentation
124+
- Production ready
125+
126+
---
127+
128+
== Types of Changes
129+
130+
- **Added** for new features
131+
- **Changed** for changes in existing functionality
132+
- **Deprecated** for soon-to-be removed features
133+
- **Removed** for now removed features
134+
- **Fixed** for any bug fixes
135+
- **Security** for vulnerability fixes

0 commit comments

Comments
 (0)