Sign inSign up

joelvaneenwyk/dotfiles

By joelvaneenwyk

ā€¢Updated over 2 years ago

Custom config files for Linux, macOS, and Windows primarily managed with gnu stow.

Image
Developer tools
1

3.8K

joelvaneenwyk/dotfiles repository overview

ā dotfiles šŸ„

 ā”ā”ā”“ā”“ ā”³ā”ā”ā”“ā”³ā”ā”“ā”³  oā”ā”ā”“
 ā”ƒā”ƒā”ƒā”—ā”ā”›ā”ƒ  ā”£ā” ā”ƒ  ā”ƒā”ƒ/ā”ƒ
 ā”› ā”‡ ā”‡ ā”—ā”ā”›ā”»ā”ā”›ā”‡ā”ā”›ā”‡ā”›ā”ā”›

Custom config files (aka. "dotfiles") for Linux, macOS, and Windows that are deployed to target with GNU Stowā . It also contains scripts for basic provisioning to install useful applications for developers (e.g., VSCode, gcc, mutagen, go, etc.) and environment tweaks (e.g., nerd fonts).

      ā–ˆā–ˆ            ā–ˆā–ˆ     ā–ˆā–ˆā–ˆā–ˆ ā–ˆā–ˆ  ā–ˆā–ˆ
     ā–‘ā–ˆā–ˆ           ā–‘ā–ˆā–ˆ    ā–‘ā–ˆā–ˆā–‘ ā–‘ā–‘  ā–‘ā–ˆā–ˆ
     ā–‘ā–ˆā–ˆ  ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆ  ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆ ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆ ā–ˆā–ˆ ā–‘ā–ˆā–ˆ  ā–ˆā–ˆā–ˆā–ˆā–ˆ   ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆ
  ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆ ā–ˆā–ˆā–‘ā–‘ā–‘ā–‘ā–ˆā–ˆā–‘ā–‘ā–‘ā–ˆā–ˆā–‘ ā–‘ā–‘ā–‘ā–ˆā–ˆā–‘ ā–‘ā–ˆā–ˆ ā–‘ā–ˆā–ˆ ā–ˆā–ˆā–‘ā–‘ā–‘ā–ˆā–ˆ ā–ˆā–ˆā–‘ā–‘ā–‘ā–‘
 ā–ˆā–ˆā–‘ā–‘ā–‘ā–ˆā–ˆā–‘ā–ˆā–ˆ   ā–‘ā–ˆā–ˆ  ā–‘ā–ˆā–ˆ    ā–‘ā–ˆā–ˆ  ā–‘ā–ˆā–ˆ ā–‘ā–ˆā–ˆā–‘ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–‘ā–‘ā–ˆā–ˆā–ˆā–ˆā–ˆ
ā–‘ā–ˆā–ˆ  ā–‘ā–ˆā–ˆā–‘ā–ˆā–ˆ   ā–‘ā–ˆā–ˆ  ā–‘ā–ˆā–ˆ    ā–‘ā–ˆā–ˆ  ā–‘ā–ˆā–ˆ ā–‘ā–ˆā–ˆā–‘ā–ˆā–ˆā–‘ā–‘ā–‘ā–‘  ā–‘ā–‘ā–‘ā–‘ā–‘ā–ˆā–ˆ
ā–‘ā–‘ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–‘ā–‘ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆ   ā–‘ā–‘ā–ˆā–ˆ   ā–‘ā–ˆā–ˆ  ā–‘ā–ˆā–ˆ ā–ˆā–ˆā–ˆā–‘ā–‘ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆ ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆ
 ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘  ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘     ā–‘ā–‘    ā–‘ā–‘   ā–‘ā–‘ ā–‘ā–‘ā–‘  ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘ ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘


  ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“
 ā–‘ā–“             ā–“
 ā–‘ā–“ about       ā–“  custom config files
 ā–‘ā–“ code        ā–“  https://github.com/joelvaneenwyk/dotfiles
 ā–‘ā–“ attribution ā–“  derived from https://github.com/jdve/dotfiles
 ā–‘ā–“             ā–“
 ā–‘ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“ā–“
 ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘ā–‘

 bash           > basic `bash` setup
 fish           > `fish` setup
 fonts          > favorite fonts
 linux          > shared profile setup
 macos          > special sauce for macOS / OSX
 windows        > helper scripts for Windows
 python         > flake8 config
 ruby           > default gems and `asdf` config
 sup            > sup mail client configs
 vim            > vim configs
 x11            > three-monitor x11 config
 xmonad         > x11 window manager configs
 zsh            > shell config for `zsh`

ā Table of Contents

ā Setup

Join the chat at https://gitter.im/dotfiles-mycelio/community

Instructions are provided below for each platform, but the high level approach for each is to clone the git repository and then run the initialization script for that platform.

To install on platforms with bash you can do the following:

curl -sL git.io/mycelio | bash

This will clone the repository and run setup.sh.

This custom URL was created using the following command:

curl -i https://git.io -F "url=https://gist.githubusercontent.com/joelvaneenwyk/dfe24a255f77b2e14e67965391a3a8fe/raw/e05066832edc673c2e6d102888ff1f5be63b9a0e/dotclone.sh" -F "code=mycelio"
ā Windows
  1. Clone the repo from your home directory:

    git clone -c core.symlinks=true --recursive https://github.com/joelvaneenwyk/dotfiles.git "%USERPROFILE%\.dotfiles"

  2. Enter the %USERPROFILE%\.dotfiles directory and run init
  3. OPTIONAL: To setup commit signing, download and install Gpg4win - Kleopatraā 
    • Import Secret Key from secure location e.g. {cloud}\Documents\Keys

NOTE: The PowerShell setup steps can fail if you have your PowerShell modules and settings stored in OneDrive or some other cloud provider. Please follow steps to migrate to local path, e.g. How to prevent Powershell Modules being installed into OneDrive - Stack Overflowā 

ā Windows Terminal
{
  "name": "\ud83c\udf44 Mycelio",
  "altGrAliasing": true,
  "antialiasingMode": "grayscale",
  "closeOnExit": "automatic",
  "colorScheme": "Campbell",
  "commandline": "%SystemRoot%\\System32\\cmd.exe",
  "cursorShape": "bar",
  "font":
  {
    "size": 12
  },
  "guid": "{e3724fc0-5da7-434c-9414-da85071c9901}",
  "hidden": false,
  "historySize": 9001,
  "icon": "ms-appx:///ProfileIcons/{0caa0dad-35be-5f56-a8ff-afceeeaa6101}.png",
  "name": "Command Prompt",
  "padding": "8, 8, 8, 8",
  "snapOnInput": true,
  "startingDirectory": "%USERPROFILE%",
  "useAcrylic": false
},
ā macOS

Most versions of MacOS will already have Git installed, and you can activate it through the terminal with git version. However, if you don't have Git installed for whatever reason, you can install the latest version of Git using one of several methodsā . Once installed, run the following:

  1. Clone the repo from your home directory:

    git -C "$HOME" clone --recursive https://github.com/joelvaneenwyk/dotfiles.git

  2. cd dotfiles && ./init-osx.sh
ā Linux
  1. Clone the repo from your home directory:

    git -C "$HOME" clone --recursive https://github.com/joelvaneenwyk/dotfiles.git

  2. Install the bash settings.

    (cd dotfiles && stow --adopt bash)

  3. Install bash settings for the root user

    sudo stow bash -t /root

  4. Install xmonadā  configs

    stow xmonad

ā Synology

  1. Update Synology to allow TCP port forwarding by adding the following to /etc/ssh/sshd_config:

    AllowTcpForwarding yes

  2. Restart SSH sudo synoservicectl --restart sshd

  3. Clone the repo from your home directory:

    git -C "$HOME" clone --recursive https://github.com/joelvaneenwyk/dotfiles.git

  4. Initialize environment.

    ./setup.sh

  5. Install bash settings for the root user

    sudo stow bash -t /root

ā Raspberry PI

  1. Clone the repo from your home directory:

    git -C "$HOME" clone --recursive https://github.com/joelvaneenwyk/dotfiles.git

  2. Navigate to dotfiles project.

    cd dotfiles

  3. Initialize the environment.

    ./setup.sh

ā Secrets

These are optional steps to setup SSH to sync to private GitHub repositories.

Instead of running each step below, you can instead run ./source/bin/setup-secrets.sh

  1. Open bash terminal e.g., Git Bash on Windows
  2. ssh-keygen -t ed25519 -C "[email protected]"
    • NOTE: Some older systems do not support Ed25519 algorithm. In those cases, use the following instead: ssh-keygen -t rsa -b 4096 -C "[email protected]"
  3. eval "$(ssh-agent -s)"
  4. ssh-add ~/.ssh/id_ed25519
  5. xclip -sel clip < ~/.ssh/id_ed25519.pub
    • Git Bash: cat ~/.ssh/id_ed25519.pub | clip
    • WSL: cat ~/.ssh/id_ed25519.pub | /mnt/c/Windows/System32/clip.exe
  6. From GitHub SSH and GPG keysā , press New SSH Key
  7. Paste in the key from the clipboard and press Save

If all worked, you should be able to clone one of your private repositories e.g. git clone [email protected]:joelvaneenwyk/secrets.git

At this point if you want to change the origin to the SSH URL you can do so with:

git remote set-url origin "[email protected]:joelvaneenwyk/dotfiles.git"

ā Introduction

In the unix world programs are commonly configured in two different ways, via shell arguments or text based configuration files. programs with many options like window managers or text editors are configured on a per-user basis with files in your home directory ~. in unix like operating systems any file or directory name that starts with a period or full stop character is considered hidden, and in a default view will not be displayed. thus the name dotfiles.

It's been said of every console user:

"you are your dotfiles".

This is because these files dictate how the system will look, feel, and function. to many users (see ricersā  and beanersā ) these files are very important, and need to be backed up and shared. people who create custom themes have the added challenge of managing multiple versions of them. i have tried many organization techniques. and just take my word for it when i say, keeping a git repo in the root of your home directory is a bad idea. i've written custom shell scripts for moving or symlinking files into place. there are even a few dotfile managers, but they all seem to have lots of dependencies. i knew there had to be a simple tool to help me.

ā Management

This repository was designed to be used with GNU Stowā , a free, portable, lightweight symlink farm manager. this allows me to keep a versioned directory of all my config files that are virtually linked into place via a single command. this makes sharing these files among many users (root) and computers super simple. and does not clutter your home directory with version control files.

Stowā  is available for all linux and most other unix-like distributions via your favorite package manager.

  • sudo pacman -S --noconfirm --needed stow
  • sudo apt-get -y install stow
  • brew install stow

This repository, however, has Stow as a submodule and builds it from sourceā  on all platforms using a modified versionā  that fully supports Windows.

ā Implementation

By default, the stow command will create symlinks for files in the parent directory of where you execute the command. so my dotfiles setup assumes this repo is located in the root of your home directory ~/dotfiles. and all stow commands should be executed in that directory. otherwise you'll need to use the -d flag with the repo directory location.

To install most of my configs you execute the stow command with the folder name as the only argument.

To install bash configs use the command:

stow bash

This will symlink files to ~/ and various other places. You can override the default behavior and symlink files to another location with the -t (target) argument flag.

Note: stow can only create a symlink if a config file does not already exist. If a default file was created upon program installation, you can add the --adopt flag which will delete the existing configuration settings before you install a new one with stow.

ā x11

To install the x11 config you need to execute the command:

stow -t / x11

This will symlink the files to /etc/X11.

ā Resources

Tag summary

Content type

Image

Digest

sha256:ceda32557ā€¦

Size

1.1 GB

Last updated

about 3 years ago

docker pull joelvaneenwyk/dotfiles