docs: Revise README to streamline content and clarify database usage

- Remove outdated sections on Systemd service and Docker Compose setup.
- Update FAQ responses for clarity on SSL requirements and database exposure risks.
- Enhance overall readability and focus on essential information.

commit: 06bcb74393dd113c28759b5d0f6f6cdb06556c75
author: bamen · 16mo ago · 2025-06-07 07:45 UTC
parent: f3b2306
signature: unsigned

1 file · +2 -43

M README.md +2 -43


@@ -259,44 +259,6 @@ podman push registry.yourdomain.com/myapp:latest
259	259		"feature-xyz.yourdomain.com" = "myapp:feature-xyz" # Feature branch
260	260		```
261	261
262		-	## 🛡️ Production-Ready
263		-
264		-	### Systemd Service
265		-	```bash
266		-	sudo tee /etc/systemd/system/gordon.service > /dev/null <<EOF
267		-	[Unit]
268		-	Description=Gordon Container Platform
269		-	After=docker.service
270		-
271		-	[Service]
272		-	Type=simple
273		-	Restart=always
274		-	RestartSec=5
275		-	ExecStart=/usr/local/bin/gordon start
276		-
277		-	[Install]
278		-	WantedBy=multi-user.target
279		-	EOF
280		-
281		-	sudo systemctl enable --now gordon
282		-	```
283		-
284		-	### With Docker Compose
285		-	```yaml
286		-	version: '3.8'
287		-	services:
288		-	gordon:
289		-	image: gordon:latest
290		-	ports:
291		-	- "80:8080"
292		-	- "443:8080"
293		-	volumes:
294		-	- /var/run/docker.sock:/var/run/docker.sock
295		-	- ./gordon.toml:/app/gordon.toml:ro
296		-	- ./data:/data
297		-	restart: unless-stopped
298		-	```
299		-
300	262		## 🤔 FAQ
301	263
302	264		Q: How is this different from Traefik/Nginx Proxy Manager?

@@ -312,10 +274,10 @@ A: Just edit gordon.toml to point to a previous version. Rollback takes seconds,
312	274		A: Nope! Your laptop is the CI/CD. Build, test locally, push when ready. Keep it simple.
313	275
314	276		Q: Do I need Cloudflare?
315		-	A: Recommended for free SSL and DDoS protection, but Gordon works with any DNS provider.
	277	+	A: Yes for SSL certificates. Gordon doesn't handle Let's Encrypt yet, so Cloudflare provides the SSL termination and DDoS protection.
316	278
317	279		Q: Can I run databases?
318		-	A: Yes! Gordon manages any container. Use volumes for persistent data.
	280	+	A: You can in theory, but exposing databases on the internet is risky. Database/app isolation is coming soon for safer database deployments.
319	281
320	282		Q: Resource requirements?
321	283		A: Runs comfortably on 1GB RAM VPS. Gordon itself uses <50MB.

@@ -403,9 +365,6 @@ curl -u admin:password https://registry.yourdomain.com/v2/_catalog
403	365		curl -u admin:password https://registry.yourdomain.com/v2/myapp/tags/list
404	366		```
405	367
406		-	### Multi-Server Setup
407		-	Deploy Gordon on multiple VPS servers with different configs for geographic distribution or separation of concerns.
408		-
409	368		## 🤝 Contributing
410	369
411	370		Gordon is open source and we love contributions! Check out our [issues](https://github.com/yourusername/gordon/issues) or submit a PR.


@@ -259,44 +259,6 @@ podman push registry.yourdomain.com/myapp:latest
259		"feature-xyz.yourdomain.com" = "myapp:feature-xyz" # Feature branch	259		"feature-xyz.yourdomain.com" = "myapp:feature-xyz" # Feature branch
260		```	260		```
261			261
262	-	## 🛡️ Production-Ready
263	-
264	-	### Systemd Service
265	-	```bash
266	-	sudo tee /etc/systemd/system/gordon.service > /dev/null <<EOF
267	-	[Unit]
268	-	Description=Gordon Container Platform
269	-	After=docker.service
270	-
271	-	[Service]
272	-	Type=simple
273	-	Restart=always
274	-	RestartSec=5
275	-	ExecStart=/usr/local/bin/gordon start
276	-
277	-	[Install]
278	-	WantedBy=multi-user.target
279	-	EOF
280	-
281	-	sudo systemctl enable --now gordon
282	-	```
283	-
284	-	### With Docker Compose
285	-	```yaml
286	-	version: '3.8'
287	-	services:
288	-	gordon:
289	-	image: gordon:latest
290	-	ports:
291	-	- "80:8080"
292	-	- "443:8080"
293	-	volumes:
294	-	- /var/run/docker.sock:/var/run/docker.sock
295	-	- ./gordon.toml:/app/gordon.toml:ro
296	-	- ./data:/data
297	-	restart: unless-stopped
298	-	```
299	-
300		## 🤔 FAQ	262		## 🤔 FAQ
301			263
302		Q: How is this different from Traefik/Nginx Proxy Manager?	264		Q: How is this different from Traefik/Nginx Proxy Manager?

@@ -312,10 +274,10 @@ A: Just edit gordon.toml to point to a previous version. Rollback takes seconds,
312		A: Nope! Your laptop is the CI/CD. Build, test locally, push when ready. Keep it simple.	274		A: Nope! Your laptop is the CI/CD. Build, test locally, push when ready. Keep it simple.
313			275
314		Q: Do I need Cloudflare?	276		Q: Do I need Cloudflare?
315	-	A: Recommended for free SSL and DDoS protection, but Gordon works with any DNS provider.	277	+	A: Yes for SSL certificates. Gordon doesn't handle Let's Encrypt yet, so Cloudflare provides the SSL termination and DDoS protection.
316			278
317		Q: Can I run databases?	279		Q: Can I run databases?
318	-	A: Yes! Gordon manages any container. Use volumes for persistent data.	280	+	A: You can in theory, but exposing databases on the internet is risky. Database/app isolation is coming soon for safer database deployments.
319			281
320		Q: Resource requirements?	282		Q: Resource requirements?
321		A: Runs comfortably on 1GB RAM VPS. Gordon itself uses <50MB.	283		A: Runs comfortably on 1GB RAM VPS. Gordon itself uses <50MB.

@@ -403,9 +365,6 @@ curl -u admin:password https://registry.yourdomain.com/v2/_catalog
403		curl -u admin:password https://registry.yourdomain.com/v2/myapp/tags/list	365		curl -u admin:password https://registry.yourdomain.com/v2/myapp/tags/list
404		```	366		```
405			367
406	-	### Multi-Server Setup
407	-	Deploy Gordon on multiple VPS servers with different configs for geographic distribution or separation of concerns.
408	-
409		## 🤝 Contributing	368		## 🤝 Contributing
410			369
411		Gordon is open source and we love contributions! Check out our [issues](https://github.com/yourusername/gordon/issues) or submit a PR.	370		Gordon is open source and we love contributions! Check out our [issues](https://github.com/yourusername/gordon/issues) or submit a PR.