mirror of
https://github.com/Matir/skel.git
synced 2026-05-25 21:19:09 -07:00
Updates
This commit is contained in:
40
README.md
40
README.md
@@ -1,16 +1,24 @@
|
||||
### About ###
|
||||
|
||||
This is a repository of configuration files that I like to have on all the
|
||||
machines that I use. I can just clone the repository and run "repo/setup.sh"
|
||||
and get most things setup the way I like them.
|
||||
machines that I use. For new systems, you can bootstrap by running the
|
||||
included `clone.sh` script:
|
||||
|
||||
```bash
|
||||
curl -L https://raw.githubusercontent.com/Matir/skel/master/clone.sh | bash
|
||||
```
|
||||
|
||||
Alternatively, you can manually clone the repository and run `./install.sh`.
|
||||
|
||||
This started just as dotfiles, but expanded to include SSH keys, GPG keys,
|
||||
packages I like installed, and an ever-growing setup script. There are various
|
||||
and an ever-growing setup script. There are various
|
||||
options to install just parts of it, such as on a machine where I only have a
|
||||
user account but no root.
|
||||
|
||||
This now uses [git-crypt](https://github.com/AGWA/git-crypt) to protect
|
||||
`private_dotfiles` for things I don't want to splash all over the internet. :)
|
||||
This environment supports using `dotfile_overlays/` or `local_dotfiles/` to
|
||||
manage machine-specific or private configurations. You can use
|
||||
[git-crypt](https://github.com/AGWA/git-crypt) on these overlay directories
|
||||
for things you don't want to splash all over the internet. :)
|
||||
I still wouldn't check in anything terribly sensitive, like private keys.
|
||||
|
||||
### Usefulness ###
|
||||
@@ -44,16 +52,30 @@ sudo apt-get install xbindkeys xdotool
|
||||
After installation, the functionality will be enabled automatically on your
|
||||
next login.
|
||||
|
||||
On macOS, you can install the recommended packages using the included `Brewfile`:
|
||||
|
||||
```bash
|
||||
brew bundle install
|
||||
```
|
||||
|
||||
### Packages ###
|
||||
|
||||
The `packages/` directory contains lists of recommended packages. You can
|
||||
manually install a set (e.g., on a Debian-based system) using:
|
||||
|
||||
```bash
|
||||
grep -v "^#" packages/cli | xargs sudo apt-get install -y
|
||||
```
|
||||
|
||||
```
|
||||
BASEDIR: Where the skel framework is installed. Defaults to $HOME/.skel
|
||||
MINIMAL: Don't do things that require git clones or installation of anything
|
||||
not included in my .skel. (Defaults to 0, installs everything.)
|
||||
not included in my .skel. (e.g., skips vim-plug, TPM) (Defaults to 0)
|
||||
INSTALL_KEYS: Install GnuPG and SSH keys. SSH keys are placed in
|
||||
authorized_keys. (Defaults to 1, installs keys.)
|
||||
TRUST_ALL_KEYS: Allow all keys to be used for SSH login, versus a small subset.
|
||||
INSTALL_PKGS: Install common packages, if on a Debian-like system.
|
||||
(Defaults to opposite of $MINIMAL.)
|
||||
SAVE: Save the install options to ${BASEDIR}/installed-prefs
|
||||
VERBOSE: Enable verbose output during installation. (Defaults to 0)
|
||||
SAVE: Save the install options to ${BASEDIR}/.installed-prefs
|
||||
```
|
||||
|
||||
### TODO ###
|
||||
|
||||
Reference in New Issue
Block a user