diff --git a/README.md b/README.md index 79d2594..477b5fe 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ -Scripts for vpses +Useful scripts for common tasks for VPSes ### Requirements -- Debian 12 or Alpine 3.21 +- Debian 12 or Alpine 3.21 or FreeBSD 14.3 - working internet - Root permissions, all scripts must be executed as root (sudo is fine) -- if virtualized, it must be **Full virtualization** (e.g. KVM) and NOT **OS-level virtualization** (e.g. OpenVZ) +- if virtualized, it must be **Full virtualization** (e.g. **KVM**) and NOT OS-level virtualization (e.g. OpenVZ) ### Tutorial 1. **CLONE** this repo -2. Edit `variables` +2. Fill in `variables` 3. Run a script or scripts \ - **IMPORTANT:** you must run this from the main directory, like `./debian/debian-secure.sh` + **IMPORTANT:** you must run this **from the main (repo) directory**, like you run `./debian/debian-secure.sh` and **as root** ### Scripts -- `variables` - settings for the scripts +- `docker-root.sh` - Installs Docker - `docker-rootless.sh` - Installs Docker and creates a user for it -- `tor-repo.sh` - Adds the [Tor repo](https://support.torproject.org/apt/). Doesn't install tor or anything. +- `tor-repo.sh` - Adds the [Tor repo](https://support.torproject.org/apt/). - `secure.sh`: - Creates a user - disallows root and password login @@ -24,11 +24,12 @@ Scripts for vpses If you'd like, you can install mosh. -### Checklist -1. Update system and reboot -2. Remove bloat like exim and cron (for low end servers) -3. Setup systemd-networkd -4. Change to random IPv6 to not expose your subnet -5. secure.sh -6. Install byobu -7. Save login info somewhere \ No newline at end of file +### Typical workflow +Relevant for Debian +1. Update the system and reboot +2. Remove bloat like exim or cron +3. Setup systemd-networkd and remove other network managers +4. Get a random IPv6 (security through obscurity) +5. `secure.sh` +6. Install mosh, byobu +7. Save the connection info somewhere \ No newline at end of file