dotfiles/README.md
DuckDuckWhale c498f0604e
Misc: doc, guides, Rust, Helix, Firefox, sshd
- An actual `README.md`
- Reorganize dual boot guide & install and swap guides
- Fix force install of Rust & Helix breaking when files already exist
- A note about Firefox Wayland CPU bug
- Remove deprecated `sshd_config` line
2023-05-10 15:19:22 -07:00

34 lines
1.8 KiB
Markdown

# Dotfiles
Here you can find my personal configuration files!
## Organization
- `auto`: automatic user level configuration script for common tools; reasonable defaults for every
machine, usually finishes instantly and requires minimal user intervention
- To configure everything, `cd` into the directory and run `./auto`
- To configure an individual piece, `cd` into that specific directory and run `./<name>`
- `manual`: manual user level configuration scripts; may be unsuitable for some machines, may run
for a while and may require user intervention (e.g. monitoring for errors and installing packages
like `gcc`)
- `rust`: installs the Rust programming language and adjust bash config files accordingly. May
consume ~1 GiB of disk space.
- `helix`: installs the Helix editor. May consume ~150 MiB of disk space.
- `setup`: Setup guides for Linux machines, mostly focused on Debian & Ubuntu. Includes
installation guides (dual boot or regular install) and system and user level
setups/configurations.
- `system`: system level utilities
- `mac-fnmode`: fix function keys' behavior when using Mac keyboards
- `sshd`: SSH daemon configuration
- Disables password authentication and only allow SSH public key authentication
- More secure and defeats brute force attempts on simple passwords
- Only users in the `ssh-users` group may log in and prevents remote root log in
- Defeats login attempts on system users and root
- Needs to be temporarily disabled if you need to unmount home partition
- `udev`: lock your screen when new human input devices are plugged in
- Defeats Bad USB attacks.
- `utils`: Utilities. Currently only includes a script to test for true color (24 bit) support,
typically under SSH/Mosh sessions and tmux. A smooth rainbow should be shown on correctly set up
systems.
- `*.asc`: my OpenPGP public keys