85 lines
3.7 KiB
Markdown
85 lines
3.7 KiB
Markdown
# homelab
|
|
|
|
Monolithic repository for my homelab
|
|
|
|
# Navigation
|
|
This repo is (mostly) organized into the following structure:
|
|
```bash
|
|
/
|
|
# The root contains repository meta-information like .gitignore,
|
|
# .gitlab-ci.yml, .gitmodules, and README.md.
|
|
docs/
|
|
# The /docs directory is for all self-contained documentation
|
|
# that is not tied to a specific service. Service-specific documentation
|
|
# is contained in /$host/config/$service/README.md
|
|
img/
|
|
# supporting images for use in docs
|
|
|
|
$host/
|
|
# There are separate directories for the details and configuration of
|
|
# each host. At the root of `/$host/` we have non-authoritative
|
|
# documentation and reference. This includes printouts of hardware
|
|
# configs (`inxi -b`), host-specific procedure docs, useful scripts, etc.
|
|
scripts/
|
|
# if a host has scripts for automating recurring tasks,
|
|
# they will be placed here.
|
|
config/
|
|
# Anything in the `/$host/config` directory is used as a source of
|
|
# truth from which hosts pull and apply the defined configuration.
|
|
$service/
|
|
# for Docker-enabled hosts each service stack will be
|
|
# configured within a directory
|
|
docker-compose.yml
|
|
# all services (except minecraft, which needed a
|
|
# more modular system) use docker-compose.yml to
|
|
# define their stack configuration.
|
|
.env
|
|
# contains environment variables to be used by multiple
|
|
# containers within a stack
|
|
README.md
|
|
# if a service stack has documentation specific to itself,
|
|
# it will be contained within this file. This usually contains
|
|
# procedure for interacting with a container and system configuration
|
|
# changes that could not be tracked in code (e.g. /etc/fstab or
|
|
# crontab or /etc/docker/daemon.json)
|
|
```
|
|
|
|
# Getting an SSH Key
|
|
1. `TMP=$(echo "$HOME/.ssh/$(echo $HOSTNAME)_id_rsa") && ssh-keygen -b 8192 -t rsa -C "$USER@$HOSTNAME" -f $TMP -N "" && echo "IdentityFile $TMP" > $HOME/.ssh/config && cat $(echo "$TMP").pub`
|
|
2. Go to Jafner -> Preferences -> SSH Keys.
|
|
3. Add the pubkey and save.
|
|
|
|
# Pulling Only Relevant Subdir
|
|
Per: https://stackoverflow.com/questions/4114887
|
|
|
|
```bash
|
|
~$ mkdir homelab && cd homelab/
|
|
git init
|
|
git config core.sparseCheckout true
|
|
git remote add -f origin ssh://git@gitlab.jafner.net:2229/Jafner/homelab.git
|
|
echo "<deployment name; e.g. server/>" > .git/info/sparse-checkout
|
|
git checkout main
|
|
```
|
|
|
|
## Disabling Sparse Checkout
|
|
To disable sparse checkout, simply run `git sparse-checkout disable`.
|
|
With this, it can also be re-eneabled with `git sparse-checkout init`.
|
|
You can use these two commands to toggle sparse checkout.
|
|
Per: https://stackoverflow.com/questions/36190800/how-to-disable-sparse-checkout-after-enabled
|
|
|
|
# Debian: Setting FQDN Hostname PS1
|
|
By default, Debian will print the domain part of its hostname (e.g. hostname `jafner.net` will print `jafner` in the terminal prompt). I like to separate my hosts by TLD (e.g. `jafner.net`, `jafner.chat`, `jafner.tools`, etc.), so printing the TLD in the hostname for the PS1 is useful.
|
|
|
|
For a standard Debian 11 installation, the PS1 is set in this block of `~/.bashrc`:
|
|
|
|
```bash
|
|
if [ "$color_prompt" = yes ]; then
|
|
PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\$ '
|
|
else
|
|
PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w\$ '
|
|
fi
|
|
```
|
|
|
|
We can achieve the desired behavior by replacing instances of `\h` with `\H` in both of these prompts (and elsewhere in the bashrc file if necessary).
|
|
|
|
Reference: [Cyberciti.biz - How to Change / Set up bash custom prompt (PS1) in Linux](https://www.cyberciti.biz/tips/howto-linux-unix-bash-shell-setup-prompt.html) |