docs: add READMEs and wiki documentation for all directories

- Add comprehensive wiki documentation under .github/wiki/ (19 articles)
- Add READMEs to directories that lacked them
- Fix merge conflict markers in existing READMEs
- Update root readme.md with improved structure

Co-authored-by: Jarvis <jarvis@wickedyoda.local>
This commit is contained in:
WickedYodaandJarvis authored and GitHub committed 2026-09-04 12:31:11 -05:00
1 parent b40aaf6f0e
commit 0c62f7495a
42 files changed
+4501 -865

No files matched your search

+59 -34
View File
@@ -1,43 +1,68 @@
<<<<<<< HEAD
# domains
## Purpose
This directory contains files related to **domains**.
## Contents
- `netflix_domains.txt`
- `blocked_domains.txt`
## Usage
- Review each script or configuration file before running
- Some scripts may require **root or sudo**
- Paths and variables may need adjustment for your environment
## Notes
- This folder is part of the **public-setupfiles** repository
- Files are provided as-is for reference or automation
## Safety
Always back up data before running scripts that modify system state.
=======
# domains
## Overview
This directory is part of the **public-setupfiles** repository.
It contains scripts, configuration files, or resources related to **domains**.
This directory contains domain lists used for various purposes in the homelab, including Pi-hole blocking, VPN allowlists, and email filtering.
## Files
| File | Description |
|------|-------------|
| `bamboo_domains.txt` | Bambu Lab 3D printer domains |
| `bypass_sites.txt` | Sites to bypass VPN/proxy |
| `combined_list.txt` | Merged block + allow lists |
| `known_porn_domains.txt` | Adult content domains |
| `social_media.txt` | Social networking platforms |
| `streaming_domains_whitelist.txt` | Netflix, Hulu, HBO Max, etc. |
| `sweden_domains.txt` | Swedish-related domains |
## Usage
- Review scripts before execution
- Some files may require **root or sudo privileges**
- Paths, variables, or credentials may need customization
## Logging & Output
Scripts may generate logs or output files in the same directory or system locations.
### Pi-hole Integration
## Safety Notes
- Always back up important data before running scripts
- Test in a non-production environment when possible
- Use at your own risk
```bash
# Add to Pi-hole
Group Management → Adlists → Add
# Use raw URL
https://raw.githubusercontent.com/wickedyoda/public-setupfiles/main/domains/social_media.txt
```
### Hosts File Blocking
```bash
# Append to /etc/hosts
127.0.0.1 blocked.domain.com
::1 blocked.domain.com
```
---
>>>>>>> main
## Domains by Category
### Social Media
Facebook, Instagram, Twitter/X, TikTok, LinkedIn, Snapchat, Threads, Bluesky, Mastodon, Reddit, Discord, etc.
### Streaming Services
Netflix, Hulu, HBO Max, Disney+, Paramount+, Peacock, Amazon Prime Video, Disney+, etc.
### Adult Content
Pornhub, XVideos, XNXX, RedTube, YouPorn, Brazzers, Livejasmin, etc.
### Bambu Lab 3D
Domains for Bambu Lab printers:
- `bambulab.com`, `api.bambulab.com`
- `public-cdn.bambulab.cn`, `cloud.bambulab.com`
- `ota.bambulab.com`, `mqtt.bambulab.com`
---
## Related Directories
- `pihole/` — Pi-hole blocklists
- `unblocked_domains_for_VPN/` — VPN bypass domains
- `Email_domains_block_allow/` — Email filtering rules