Reorganize repository structure and refresh READMEs

This commit is contained in:
WickedYoda committed 2026-04-08 14:57:07 -05:00
1 parent 2270530d9e
commit a8b7ccbf2a
170 files changed
+616 -1391

No files matched your search

+16 -42
View File
@@ -1,46 +1,20 @@
# Public Setup Files
# public-setupfiles
This repository contains a collection of scripts and configuration snippets I use across various systems. Most scripts target Debian/Ubuntu Linux, but you'll also find utilities for macOS, Raspberry Pi, OpenWrt, and Docker environments. The goal is to speed up system deployment and automate routine maintenance tasks.
## Overview
This repository is a collection of setup scripts, maintenance utilities, backup helpers, and infrastructure notes for Linux, macOS, Windows, Docker, and home-lab style systems.
---
## Layout
- `backup_and_storage/` contains backup jobs, file-copy helpers, mount setup, and folder redirection scripts.
- `platform_setup/` contains operating-system and platform-specific setup scripts for Debian, Ubuntu, Kali, macOS, Raspberry Pi, OpenWrt, Cockpit, and Paperless-ngx.
- `monitoring_and_remote_admin/` contains monitoring, SNMP, Observium, Telegraf, Docker monitoring helpers, and multi-machine command runners.
- `network_and_policies/` contains domain allow/block lists and VPN-related allowlists.
- `repo_automation/` contains repository maintenance helpers, cron setup utilities, reset scripts, and general update automation.
## 🔎 Directory Overview
## Root Files
- `LICENSE` and `SECURITY.md` contain repository policy and licensing information.
- `public-setupfiles.code-workspace` is the workspace file for local editing.
- **Email_domains_block_allow/** – Lists of domains to allow or block for email filtering.
- **Kali_tools_install/** – Scripts to install popular Kali Linux security tools on Debian-based systems, including [Kali Purple setup instructions](https://wickedyoda.com/?p=3131).
- **batch_files/** – Windows batch files for backups and other automation.
- **blocked_domains/** – Domain blocklists used by some of the setup scripts.
- **cockpit/** – Installation helper for the Cockpit web administration interface.
- **copy-move-files/** – Shell scripts to copy or move media files between locations.
- **copy_palworld_local/** – Python helper for backing up Palworld server data.
- **cron-job-setup-files/** – Tools for configuring recurring cron jobs.
- **debian-files/** – Miscellaneous Debian utilities (e.g., installing bashtop).
- **docker/** – Docker and Docker Compose setups including Greenbone, Jellyfin and Portainer.
- **fstab-setup/** – Scripts to build and apply `/etc/fstab` mount entries.
- **git_clone_setup/** – Notes and helpers for cloning repositories.
- **mac-scripts/** – Assorted macOS helper scripts.
- **observium/** – Installer for the Observium monitoring agent.
- **openwrt_scripts/** – Utilities for managing OpenWrt routers.
- **paperless-ngx/** – Script to install the Paperless‑ngx document server.
- **raspberrypi/** – Backup and application install scripts for Raspberry Pi systems.
- **reset_perms/** – Simple scripts to reset file and directory permissions.
- **server_config/** – Example configuration files for Debian and Ubuntu servers.
- **snmp/** – SNMP configuration scripts for Linux and OpenWrt.
- **system_command_run/** – Run a command across multiple machines via SSH.
- **telegraf-setup-scripts/** – Install script for the Telegraf metrics agent.
- **ubuntu-based/** – Application install script for Ubuntu-based systems.
- **unblocked_domains_for_VPN/** – Domain list allowed through a VPN connection.
- **updates_scripts/** – Scripts to update or upgrade packages on a system.
Root-level helper scripts include:
- `update-from_repo.py` – Python script to sync updates from this repository.
- `update-from_repo.sh` – Bash version of the update sync script.
---
## 🐙 Cloning This Repository
To clone this repository and switch to the main branch:
```sudo curl -s https://raw.githubusercontent.com/wickedyoda/public-setupfiles/refs/heads/main/update-from_repo.sh | sudo bash```
## Notes
- Content was reorganized into category folders to make navigation easier without deleting existing scripts.
- Each project folder now has its own `README.md` describing what it contains.
- Review every script before running it on a live system, especially anything that changes mounts, packages, services, cron jobs, or Docker.