Refactor README and SearXNG notes for improved formatting and clarity
All checks were successful
CI / skip-ci-check (pull_request) Successful in 1m27s
CI / markdown-lint (pull_request) Successful in 1m29s
CI / yaml-validate (pull_request) Successful in 1m30s

- Updated README.md to enhance the prompt structure for generating service documentation.
- Reformatted code blocks in searxng-lxc-notes.md for better readability and consistency.
This commit is contained in:
ilia 2026-01-07 12:23:21 -05:00
parent bdb4330dca
commit d8e98b1aa2
2 changed files with 40 additions and 40 deletions

View File

@ -26,17 +26,17 @@ This is an actively evolving notebook. Some sections may be incomplete or “wor
When adding a new container/VM/service, use this prompt with an LLM to generate a first draft of notes (similar style to the rest of this repo): When adding a new container/VM/service, use this prompt with an LLM to generate a first draft of notes (similar style to the rest of this repo):
> You are helping me maintain my homelab-notes repo. > You are helping me maintain my homelab-notes repo.
> I am adding or modifying ONE service/container/VM. > I am adding or modifying ONE service/container/VM.
> Read the snippets I paste from my terminal (docker-compose, configs, IPs, curl outputs, etc.) and then produce a single Markdown file in the same style as other *-notes.md in this repo: > Read the snippets I paste from my terminal (docker-compose, configs, IPs, curl outputs, etc.) and then produce a single Markdown file in the same style as other *-notes.md in this repo:
> >
> - Start with a short description of what the service is and where it runs. > - Start with a short description of what the service is and where it runs.
> - Capture design/architecture decisions (networking, reverse proxy, storage, security). > - Capture design/architecture decisions (networking, reverse proxy, storage, security).
> - Document IPs, hostnames, ports, container names, and paths that are specific to my environment. > - Document IPs, hostnames, ports, container names, and paths that are specific to my environment.
> - Include trimmed config examples (docker-compose, Caddy/nginx, app config) with comments where helpful. > - Include trimmed config examples (docker-compose, Caddy/nginx, app config) with comments where helpful.
> - Add a small “Deployment steps” section summarizing the exact commands I used (cd, docker compose up, systemctl, etc.). > - Add a small "Deployment steps" section summarizing the exact commands I used (cd, docker compose up, systemctl, etc.).
> - Add brief “Troubleshooting notes” if we fixed any issues (e.g., wrong port binding, DNS, reverse proxy issues). > - Add brief "Troubleshooting notes" if we fixed any issues (e.g., wrong port binding, DNS, reverse proxy issues).
> >
> Do NOT invent services or values that I did not show you. > Do NOT invent services or values that I did not show you.
> Only use the information I provide plus obvious inferences (e.g., 0.0.0.0:8080 means accessible on LAN). > Only use the information I provide plus obvious inferences (e.g., 0.0.0.0:8080 means accessible on LAN).
> Output ONLY the Markdown for the new note file, no explanation around it. > Output ONLY the Markdown for the new note file, no explanation around it.

View File

@ -199,9 +199,9 @@ Update the `secret_key` in `settings.yml` with the generated value.
1. **SSH to LXC** and navigate to the directory: 1. **SSH to LXC** and navigate to the directory:
```bash ```bash
cd /opt/searxng-docker cd /opt/searxng-docker
``` ```
2. **Edit docker-compose.yaml** to: 2. **Edit docker-compose.yaml** to:
- Remove the caddy service and related volumes - Remove the caddy service and related volumes
@ -209,33 +209,33 @@ cd /opt/searxng-docker
3. **Configure settings.yml** (if customizing): 3. **Configure settings.yml** (if customizing):
```bash ```bash
# Copy default settings if not present # Copy default settings if not present
cp searxng/settings.yml.example searxng/settings.yml cp searxng/settings.yml.example searxng/settings.yml
# Edit settings.yml # Edit settings.yml
nano searxng/settings.yml nano searxng/settings.yml
``` ```
4. **Start/restart stack**: 4. **Start/restart stack**:
```bash ```bash
docker compose up -d docker compose up -d
docker compose ps # Confirm searxng -> 0.0.0.0:8080->8080 docker compose ps # Confirm searxng -> 0.0.0.0:8080->8080
``` ```
5. **Check logs**: 5. **Check logs**:
```bash ```bash
docker compose logs -f searxng docker compose logs -f searxng
docker compose logs -f redis docker compose logs -f redis
``` ```
6. **Quick local test** from another host on LAN: 6. **Quick local test** from another host on LAN:
```bash ```bash
curl -v http://10.0.10.70:8080/ | head curl -v http://10.0.10.70:8080/ | head
``` ```
Expected: HTML for SearXNG front page, status 200 from server granian. Expected: HTML for SearXNG front page, status 200 from server granian.
@ -294,19 +294,19 @@ Ensure the Proxmox firewall allows traffic between VMs/LXCs on the same network.
2. **Network Isolation**: SearXNG only needs to be accessible from the Caddy VM, not the entire network 2. **Network Isolation**: SearXNG only needs to be accessible from the Caddy VM, not the entire network
3. **Updates**: Regularly update Docker images: 3. **Updates**: Regularly update Docker images:
```bash ```bash
cd /opt/searxng-docker cd /opt/searxng-docker
docker compose pull docker compose pull
docker compose up -d docker compose up -d
``` ```
4. **Logging**: Consider disabling or limiting logging for privacy: 4. **Logging**: Consider disabling or limiting logging for privacy:
```yaml ```yaml
# In settings.yml # In settings.yml
general: general:
enable_metrics: false enable_metrics: false
``` ```
5. **Rate Limiting**: Configure rate limiting in Caddy if needed to prevent abuse 5. **Rate Limiting**: Configure rate limiting in Caddy if needed to prevent abuse