dotfiles

dotfiles [

Being a Linux user is sort of like living in a house inhabited by a large family of carpenters and architects. Every morning when you wake up, the house is a little different. Maybe there is a new turret, or some walls have moved. Or perhaps someone has temporarily removed the floor under your bed."

— Unix for Dummies, 2nd Edition

These are various config files I use for my Linux environment and related programs.

Table of Contents

• Overview
• Applications
• Installing
• Feedback
• Author

Obligatory Warning
You should first fork this repository, review the code, and remove things you don't want or need. Don't blindly use my settings unless you know what that entails. Here be dragons!

Overview

Here's a high level overview if you just want to see what I use:

Category	Program
Distro:	Debian
Browser:	Chromium
Shell:	Zsh
Shell Plugins:	Antigen & Oh-My-Zsh
Shell Theme:	Sunrise (modified)
Editor:	nano
IDE:	Kate
Media player:	SMPlayer (mpv backend)

Applications

This is a list of all the applications managed in this repo. Each link to the respective project's homepage. The superscript letters have special meaning, ^h and ^r are the most important.

• bash ^ah: classic Bourne shell
• cgit ^vr: a fast web interface for git repos
• git ^ah: distributed version control
• lighttpd ^svr: a lightweight webserver that's easy to configure
• nano ^a: an easy to use CLI editor
• mpv ^dh: a media player on par with VLC's extensive codecs
• php ^svr: a scripting language for interactive websites
• quirk-no-lid-suspend ^sr: don't suspend when the laptop lid is closed
• quirk-oom-killer-reboot ^svr: reboot when out of memory instead of killing processes
• smplayer ^dh: A frontend for mpv
• ssh ^ah: secure remote shell
• sshd ^svr: secure shell server
• ufw ^ar: a frontend to simplify iptables
• wget ^ah: console download manager
• youtube-dl ^dh: download videos from almost any site
• xdg-user-dirs ^dh: control the location of default directories like ~/Desktop and ~/Downloads
• zsh ^ah: a shell that's slightly easier to configure
• attic/
  • Previously used applications and experiments. Your mileage may vary, but some may find them useful.

Superscript Legend

The superscript letters after application names shows which machines each configuration is used on and if you need to tell stow to place the configuration in the root directory.

Machines: ^{a d s v}

• ^a (all): bash, git, zsh, wget, ssh, nano
• ^d (desktop): smplayer, mpv, xdg-user-dirs, youtube-dl
• ^s (home server): quick-no-lid-suspend, quirk-oom-killer-reboot, sshd
• ^v (VPS): quirk-oom-killer-reboot, sshd

Targets: ^{h r}

• ^h (home): a typical dotfile meant for $HOME, run stow as usual (e.g. stow bash)
• ^r (root): system configuration, such as those found in /etc. Use the target flag for the root directory (e.g. stow -t / sshd)

Installation / Managing

These dotfiles are managed with stow, which allows you to group dotfiles based on the programs they configure. Thus, you can pick and choose which dotfiles you want to install.

For instance, to install all the related bash dotfiles:

$ cd ~  
$ git clone https://github.com/keithieopia/dotfiles.git  
$ cd ~/dotfiles  
$ stow bash

System config files are marked with ^r in the above application list. You will need to tell stow to put it in the root directory, by passing the -t / flag, like so:

$ sudo stow -t / sshd

This seems to be a pain... how do you really manage it?

With a Makefile, believe it or not. It has targets for all my machines by hostname, which auto installs all of the relevant stow targets. It sounds more complicated than it is, but makes installation a breeze. All I end up running is:

$ cd ~/dotfiles && make

...and I'm all setup! For new hosts not in the Makefile, I have some default targets, like "desktop" or "servers" that I can use. If you have several hosts with different stow targets, I recommend you tryout using make instead of overthinking the problem.

Feedback

I would love your feedback! If you found any of these config files useful, please drop me an email. For the privacy conscious, feel free to encrypt any messages using my PGP key:

46E6 9F69 90C1 DE8C 9791 88EE 94A4 E2D4 6B32 AA11

To import it into your keyring:

$ curl https://gist.githubusercontent.com/keithieopia/434f3575ec1f020d6589a4c01dc0847e/raw/2e0749f2966ff501ee28797a926229c081f7e652/timothykeith.pub.asc | gpg --import -

NOTE: SKS Public Key Servers (such as pgp.mit.edu) don't support Curve25519 keys yet. In the meantime, consider using Keybase.io; my username is timothykeith.

Bug Reports

Submit bug reports via GitHub's Issue Tracker

Author

Copyright © 2016 - 2017 Timothy Keith

Licensed under the MIT license.

This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.