Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trskop/dot.config
User configuration files (dot-files)
https://github.com/trskop/dot.config
dotfiles gitconfig haskell tmux tmux-conf
Last synced: 10 days ago
JSON representation
User configuration files (dot-files)
- Host: GitHub
- URL: https://github.com/trskop/dot.config
- Owner: trskop
- Created: 2018-07-15T12:40:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-31T20:51:41.000Z (about 3 years ago)
- Last Synced: 2023-04-30T01:07:42.955Z (over 1 year ago)
- Topics: dotfiles, gitconfig, haskell, tmux, tmux-conf
- Language: Haskell
- Size: 750 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
User configuration files (dot–files)
====================================
* [`bash/`](./bash/) – Configuration for Bash shell, most notablly
`~/.bashrc`, i.e. [`bash/dot.bashrc`](./bash/dot.bashrc).
* [`bat/`](./bat/) – Configuration for `bat` command, see
[`bat/README.md`](./bat/README.md) for more information.
* [`bazel/`](./bazel) – Bazel build system user-specific configuration.
See [`baze/README.md`](./bazel/README.md)
* [`command-wrapper/`](./command-wrapper/) – Global Command Wrapper
configuration. See [`command-wrapper/README.md`
](./command-wrapper/README.md) for more information.
* [`ghc/`](./ghc/) – GHCi configuration, see
[`ghc/README.md`](./ghc/README.md) for more information.
* [`git/`](./git/) – Git configuration, see
[`git/README.md`](./git/README.md) for more information.
* [`habit/`](./habit/) – Configuration of Command Wrapper toolset optimised
for work environment. See [`habit/README.md`](./habit/README.md) for more
details.
* [`haskeline/`](./haskeline/) – Haskeline configuration, see
[`haskeline/README.md`](./haskeline/README.md) for more information.
* [`kitty/`](./kitty/) – Kitty terminal emulator configuration, see
[`kitty/README.md`](./kitty/README.md).
* [`mplayer/`](./mplayer/) – MPlayer configuration, see
[`mplayer/README.md`](./mplayer/README.md) for more information.
* [`nvim/`](./nvim/) – Neovim configuration, see
[`nvim/README.md`](./nvim/README.md) for more information.
* [`psql/`](./psql/) – PostgreSQL interactive terminal (`psql`) configuration,
see [`psql/README.md`](./psql/README.md) for more information.
* [`readline/`](./readline/) – Readline configuration, see
[`readline/README.md`](./readline/README.md) for more information.
* [`ripgrep/`](./ripgrep/) – Ripgrep configuration, see
[`ripgrep/README.md`](./ripgrep/README.md).
* [`sensible-editor/`](./sensible-editor/) – Configuration files for
`sensible-editor`, a Debian-specific tool. See `sensible-editor(1)` and
[`sensible-editor/README.md`](./sensible-editor/README.md) for more
information.
* [`stack/`](./stack/) – Haskell Stack, see
[`stack/README.md`](./stack/README.md).
* [`tldr/`](./tldr/) — Configurable [tldr-pages](https://tldr.sh/) client
with support for custom pages, see [`tldr/README.md`](./tldr/README.md).
* [`tmux/`](./tmux/) – Tmux configuration, see
[`tmux/README.md`](./tmux/README.md) for more information.
* [`yx/`](./yx/) – Configuration of Command Wrapper toolset optimised for
personal use. See [`yx/README.md`](./yx/README.md) for more details.
* [user-dirs.dirs](./user-dirs.dirs) and
[user-dirs.locale](./user-dirs.locale) are XDG configuration files for
special user directories. See `xdg-user-dir(1)` and
`xdg-user-dirs-update(1)` for more information.
* [`Xresources`](./Xresources) – `~/.Xresources` configuration file.
TODO:
* Merge into this repository.
Installation
------------
Some dependencies need to be installed. On Debian it is:
```Bash
sudo apt install haskell-stack curl libtinfo-dev zlib1g-dev
```
We are expecting that there are some files already present in your `~/.config/`
directory. This installation process will leave them untouched, but you may
need to resolve issues with files that exist both locally and in the
repository.
```Bash
cd ~/.config/
git init
git remote add origin [email protected]:trskop/dot.config.git
git fetch --all
git checkout -b master origin/master
```
If installing on a clean system then `~/.config` directory may not exist, in
which case it becomes a little bit easier. We'll be using HTTPS protocol
instead of SSH, since SSH key for accessing GitHub may not be present on a
pristine system. Just reconfigure remote URL afterwards.
```Bash
git clone https://github.com/trskop/dot.config.git ~/.config
```
Make sure to use `~/.local/bin` for your executables instead of `~/bin`:
```Bash
cd ~
mkdir -p ~/.local/bin
if [ -e ~/bin ]; then mv ~/bin/* ~/.local/bin/; fi
rmdir bin
```
For backward compatibility it is possible to do this:
```Bash
ln -s .local/bin bin
```
Now make sure that `~/.profile` and `~/.bash_profile` add `~/.local/bin` into
your `$PATH` instead of `~/bin`.
Make sure that `stack` installed through the system package is sufficiently
new. If not then run:
```Bash
stack upgrade
```
To avoid long bootstrapping sequence when calling Haskell scripts it may be a
good idea to run:
```Bash
stack setup 8.10.4
```
Where `8.10.4` is GHC version used by `~/.config/dot.config.init.hs`. Please
check the Stackage LTS version specified in it to be sure as this documentation
may be out of date.
Now we need to install everything:
```Bash
~/.config/dot.config.init.hs bootstrap
yx this -Uusin
```
Version-controlled Host-specific Configuration
----------------------------------------------
Host-specific configuration is stored in `~/.local/src/localhost` repository
with following directory structure:
```
~/.local/src/localhost/
├── ${host}/
│ ├── dot.config/ <── Private configuration that would normally go to
│ │ │ ${XDG_CONFIG_HOME:-${HOME}/.config}
│ │ └── ...
│ │
│ └── notes/ <── Notes about the hardware, installation specifics, etc.
│ │ Basically anything that is easily forgotten once the
│ │ system is installed and configured.
│ └── ...
│
├── this -> ${host}
└── dot.config -> this/dot.config
```
Where `${host}` is the result of `hostname --fqdn`. This allows us to
reuse/share the repository for multiple machines. One such example is when one
machine dies, and new one has to be installed. Copying over existing
repository can serve as a nice starting point.
Script [`scripts/init-host-specific-config-repo.bash`
](./scripts/init-host-specific-config-repo.bash) is provided to create the
repository with the above structure. It can be invoked as:
```Bash
bash ~/.config/scripts/init-host-specific-config-repo.bash
```
Scripts
-------
* [`scripts/init-host-specific-config-repo.bash`](./scripts/init-host-specific-config-repo.bash)
– Initialise version-controlled host-specific configuration repo. See
[Version-controlled Host-specific Configuration
](#version-controlled-host-specific-configuration) section for more
information.
* [`scripts/dhall-lsp-server-wrapper`](./scripts/dhall-lsp-server-wrapper) –
Run `dhall-lsp-server`, but if it's not available locally then download it
first.
Other Resources
---------------
* [XDG Base Directory Specification
](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
* [ArchWiki: XDG Base Directory
](https://wiki.archlinux.org/index.php/XDG_Base_Directory)