docs: add comprehensive privacy policy and analytics documentation
New documentation: - PRIVACY.md: Complete privacy policy covering Matomo analytics, cookies, and data handling - Clear opt-out instructions and developer guidelines README.md updates: - Add Privacy & Analytics section with clear disclosure - List what's tracked vs. what's NOT tracked - Add "Privacy-Friendly Analytics" to features list - Add critical configuration requirements for template users - Crystal clear instructions: MUST change Matomo Site ID and server URL - OR remove analytics entirely if not needed CUSTOMIZATION.md updates: - Add comprehensive "Analytics Configuration" section (120+ lines) - Option 1: Configure your own Matomo instance (step-by-step) - Option 2: Remove Matomo completely (clean removal steps) - Option 3: Use alternative analytics providers (Google Analytics, Plausible, etc.) - Include exact file locations and line numbers for changes - Privacy compliance checklist (GDPR, CCPA, cookie banners) - Testing instructions to verify analytics configuration Key highlights for template users: - MUST change: Site ID (line 644), Server URL (line 642), CSP headers - MUST update: PRIVACY.md with own contact info - Complete removal guide if analytics not wanted - Legal compliance reminders All documentation is crystal clear with exact locations, code examples, and warnings.
This commit is contained in:
@@ -27,6 +27,7 @@ A professional, bilingual CV site with server-side PDF generation, HTMX interact
|
||||
- [Documentation](#-documentation)
|
||||
- [Deployment](#-deployment)
|
||||
- [Customization](#-customization)
|
||||
- [Privacy & Analytics](#-privacy--analytics)
|
||||
- [Contributing](#-contributing)
|
||||
- [License](#-license)
|
||||
- [Support](#-support)
|
||||
@@ -42,6 +43,7 @@ A professional, bilingual CV site with server-side PDF generation, HTMX interact
|
||||
- ✅ **JSON-Based Content** - Easy to update without touching code
|
||||
- ✅ **AI Development Section** - Showcases modern AI-assisted development skills
|
||||
- ✅ **Fast & Lightweight** - Go backend with chromedp for PDF generation
|
||||
- ✅ **Privacy-Friendly Analytics** - Self-hosted Matomo tracking (no third-party data sharing)
|
||||
- ✅ **Security Hardened** - CSP headers, XSS protection, origin validation, rate limiting
|
||||
- ✅ **Production Ready** - Systemd service, CI/CD workflows, deployment guides
|
||||
- ✅ **Developer Friendly** - Hot reload, clear code structure, comprehensive Makefile
|
||||
@@ -202,16 +204,48 @@ The [CUSTOMIZATION.md](CUSTOMIZATION.md) guide includes:
|
||||
- Adding new languages
|
||||
- Advanced customization patterns
|
||||
|
||||
## 🔒 Privacy & Analytics
|
||||
|
||||
This site uses **self-hosted Matomo analytics** to understand visitor behavior while respecting privacy.
|
||||
|
||||
**What's tracked:**
|
||||
- Page views and language changes (EN/ES)
|
||||
- Visitor country/city (approximate)
|
||||
- Browser type and referring site
|
||||
- Time on site and navigation patterns
|
||||
|
||||
**What's NOT tracked:**
|
||||
- Personal identifying information
|
||||
- Precise geolocation
|
||||
- Cross-site behavior
|
||||
- Any data is NOT shared with third parties
|
||||
|
||||
**Your privacy:**
|
||||
- All data stored on my own server (`matomo.drolo.club`)
|
||||
- Respects "Do Not Track" browser settings
|
||||
- You can disable cookies in browser settings
|
||||
|
||||
See **[PRIVACY.md](PRIVACY.md)** for complete details and opt-out instructions.
|
||||
|
||||
---
|
||||
|
||||
## 🤝 Using This Template
|
||||
|
||||
**This project is open-source and available for you to use!**
|
||||
|
||||
✅ **Fork it** and create your own CV
|
||||
✅ **Customize** following [CUSTOMIZATION.md](CUSTOMIZATION.md)
|
||||
✅ **Star it** ⭐ if you find it useful
|
||||
✅ **Share it** with others who might benefit
|
||||
**If you use this as a template, you MUST change:**
|
||||
1. **Matomo Site ID** in `templates/index.html` (line 644): Change `setSiteId` from `'4'` to your own
|
||||
2. **Matomo Server URL** in `templates/index.html` (line 642): Change `https://matomo.drolo.club/` to your instance
|
||||
3. **CSP Headers** in `internal/middleware/security.go`: Update allowed domains for your Matomo server
|
||||
4. **OR remove Matomo entirely** if you don't want analytics (see [PRIVACY.md](PRIVACY.md#for-developers-using-this-code))
|
||||
|
||||
**Note:** This is a personal portfolio project. I'm not actively accepting contributions, but you're free to use it as a template for your own CV!
|
||||
**Other recommended changes:**
|
||||
- Update all personal information in `data/cv-en.json` and `data/cv-es.json`
|
||||
- Replace profile photo in `static/images/profile/`
|
||||
- Update `ALLOWED_ORIGINS` in `.env` for API protection
|
||||
- Customize colors and branding in `static/css/main.css`
|
||||
|
||||
See **[CUSTOMIZATION.md](CUSTOMIZATION.md)** for the complete customization guide.
|
||||
|
||||
## 📄 License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user