docs: condense markdown files into single document #3
Conversation
This file contains hidden or 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
- Add DEPLOYMENT.md with concise, actionable deployment guide for Hetzner VPS - Create cloud-config.yaml with improved error handling and security practices - Add error handling (|| exit 1) to all runcmd steps - Add Persistent=true to gitops-update timer - Add security headers to Caddy config - Add proper permissions to gitops-update.sh - Improve comments and documentation - Update HOSTING.md to redirect to DEPLOYMENT.md - Add deployment reference in README.md - Remove old cloud-config.txt file The new DEPLOYMENT.md provides a complete guide covering: - Prerequisites and quick deployment steps - Configuration checklist - Syncthing setup - GitOps auto-updates - Monitoring and troubleshooting - Security notes and best practices - Backup and maintenance procedures
KyleKing
changed the title
Added detailed documentation to address common deployment questions: DNS Configuration Section: - Cloudflare-specific setup instructions (A record, SSL/TLS mode) - Explanation of gray cloud vs orange cloud (proxy status) - Instructions for other DNS providers - DNS verification commands - Timing considerations for DNS propagation Let's Encrypt / HTTPS Section: - Detailed explanation of how Caddy auto-provisions certificates - Step-by-step certificate issuance process - Common failure scenarios and solutions - Timeline expectations (2-5 minutes after VPS reboot) - Commands to verify HTTPS is working correctly Enhanced Troubleshooting: - New comprehensive "SSL Certificate / HTTPS Issues" section - Specific Cloudflare troubleshooting steps - Certificate renewal procedures - Port accessibility testing - Common error messages with solutions Quick Deployment Updates: - Added step to configure DNS immediately after VPS creation - Explanation of why DNS should be set up early - Added Caddy log checking to verification step - Fixed step numbering This addresses the critical gap where users might not know: 1. DNS must be configured for Let's Encrypt to work 2. What Cloudflare settings are needed 3. How to verify HTTPS will work before waiting for deployment
KyleKing
deleted the
claude/condense-markdown-files-01FM4AVoNttDxYXCtYQnTp6S
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The new DEPLOYMENT.md provides a complete guide covering: