Git & GitHub Guide#

1 Installation & Initial Configuration#

1.1 Installation#

MacOS (Requires Homebrew)#

brew install git

Linux (Debian/Ubuntu)#

apt-get install git

Verify Version#

git --version

1.2 Global Configuration#

# Set Identity
git config --global user.name "Marc Ouellet"
git config --global user.email "marc.ouellet@gmail.com"

# Set Default Branch to match GitHub (main)
git config --global init.defaultBranch main

# Verify Settings
git config --global user.name
git config --global user.email

# Common Alias
git config --global alias.s "status"

2 The Collaborative Workflow#

To work simultaneously on the same project without overwriting each other, you should follow a specific cycle for every work session. This process ensures that everyone stays in sync while moving one step at a time.

1 Core Obsidian Shortcuts#

These are the most essential keys for building your homelab documentation rapidly.

2 Linking to Headings with Wikilinks Disabled#

Since we switched to Standard Markdown Links, use these to keep the “network” alive.

1. Pangolin Pre-Update Requirements#

1.1. Backup Data#

Always backup your data before updating. Copy your config directory to a safe location to allow for a rollback if necessary.

1.2. Version Strategy#

Update incrementally between major versions (e.g., 1.0.0 → 1.1.0 → 1.2.0) rather than skipping major releases.

2. Update Process#

2.1. Stop the Stack#

Stop all running containers:

sudo docker compose down

2.2. Check Latest Versions#

Before editing your configuration, verify the current stable release versions for each component: