diff --git a/README.md b/README.md index 9f4a52c..05836cd 100644 --- a/README.md +++ b/README.md @@ -1,104 +1,8 @@ -# My personal dotfiles for my laptop: Kubuntu 22.04.1 +# My personal dotfiles for my laptop -![CI](https://github.com/pacoorozco/dotfiles/workflows/CI/badge.svg) [![License][license-badge]][license] -This project contains the dotfiles and custom shell scripts that I use on my workstations. - -**Why keep them at GitHub?** It’s a way to share advanced shell tips with other developers, and more practically, a way to back up my configuration. I was tired of having a bunch of configurations across all my machines, especially when trying to keep all up to date. So I got fed up and threw them on GitHub. It's not perfect (yet!), but it's a great starting point for any Linux config. - -## Introduction -Each folder is named after a package and contains every configuration file used by that application. Besides some noted exceptions, the files inside the folders are relative to home (e.g. the file `vim/.vimrc` goes to `~/.vimrc`). - -Every section here explains which settings and (if any) workarounds/fixes are used to obtain the described result. - -For further reference, read carefully every section in this file, and copy only the configuration files relative to the parts you are trying to setup. - -If none of these helped, feel free to open an issue here. Include your distro informations and the configuration values you are trying. - -## Handy scripts -These scripts will be installed to `~/bin` and added to your `$PATH`: - -| Script | Description | -| --- | --- | -| `fs-cryptmount.sh` | Mounts a encFS filesystem where I keep personal data. | -| `myip.sh` | An script to obtain my real IP. | - -## Shell enhancements - -### zsh (default) -* [oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) - framework for managing your zsh configuration. It includes autocompletion, themes, aliases, custom functions... -* [powerlevel10k/powerlevel10k](https://github.com/romkatv/powerlevel10k) theme - emphasizes speed, flexibility and out-of-the-box experience. -* Plugins: - * aws - * colored-man-pages - * extract - * git - * pass - * [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions) - suggest commands as you type, based on command history -* `$EDITOR` is `vim`. -* `umask` is `077`. -* Configure private tokens from `$HOME/.env_private`. - -### bash -* Enable [Bash-it](https://github.com/Bash-it/bash-it) framework. It includes autocompletion, themes, aliases, custom functions... -* Improved Bash history based on [this post](https://www.digitalocean.com/community/tutorials/how-to-use-bash-history-commands-and-expansions-on-a-linux-vps). -* Add useful aliases, like `ll`, `la`... -* `$EDITOR` is `vim`. -* `umask` is `077`. -* Configure private tokens from `$HOME/.env_private`. - -## Git configuration -* Enables color output and line-ending checks. -* Shortens common commands: `br`, `ci`, `co`, `df`, `lg`. - -> Remember to configure `user.name`, `user.email` and `user.signingkey` on `.gitconfig`. - -## Vim Configuration -- 4 spaced tabs -- Autocompletion always on -- Case insensitive search -- Global highlighting of search matches -- Numbered lines -- Trailing whitespace highlighting -- Tons of plugins through [Vundle](https://github.com/VundleVim/Vundle.vim): `onedark`, `lightline`, `vim-ployglot`. -- [One Dark](https://github.com/joshdick/onedark.vim) theme - -## Applications - -### Backup tool - -My personal backup solution for my `$HOME` folder (to local and external HD) - -* Uses `rsync` to keep snapshots of your `$HOME` folder to a local folder or external HD. -* You can configure the list of files & folders to exclude from the backup. See `~/.excludes_from_backup`. -* You can configure your destination folders. See `DESTINATION` variable in the scripts. - -| Script | Description | -| --- | --- | -| `daily.sh` | Do a daily backup (scheduled in the `crontab`) into a local folder. See `DESTINATION`. | -| `weekly.sh` | Do a weekly backup (scheduled in the `crontab`) of the latest folder create by `daily.sh` into a local folder. See `DESTINATION`. | -| `make_snapshot.sh` | Creates the snapshoot of the source folder and **keep three older copies** (rotated on each backup) | -| `do_backup.sh` | Do the backup to remote (mounted disk) using `make_snapshot.sh`. See `DESTINATION`. | - -### DNS Over TLS using `systemd` - -I've configured my workstation to use [DNS Over TLS](https://developers.google.com/speed/public-dns/docs/dns-over-tls) without any dependency, just `systemd`. It uses the [AdGuard DNS](https://adguard-dns.io/en/public-dns.html), a reliable way to block ads on the Internet. - -The installation allows you to configure it without any effort and a script to enable/disable it is provided. In order to connect to WiFi with captive portals you should disable DNS Over TLS first. - -| Script | Description | -| --- | --- | -| `DNS_Over_TLS.sh` | Enable/disable DNS-Over-TLS. | - -# Installation -Choose a place to store the dotfiles, like `~/.dotfiles`. - -```bash -git clone https://github.com/pacoorozco/dotfiles.git ~/.dotfiles -cd ~/.dotfiles -./install.sh -``` +This repository has been moved to [codeberg](https://codeberg.org/pakus/dotfiles). [license]: https://github.com/pacoorozco/dotfiles -[license-badge]: https://img.shields.io/github/license/pacoorozco/dotfiles.svg?style=flat-square +