Files
apf_portal/docs/setup/README.md
T
Julien Gautier 5821c60195
CI / commits (pull_request) Successful in 3m1s
CI / check (pull_request) Successful in 3m11s
CI / scan (pull_request) Successful in 3m17s
CI / a11y (pull_request) Successful in 3m23s
Docs site / build (pull_request) Successful in 3m42s
CI / perf (pull_request) Successful in 5m11s
docs(setup): use ~/.bashrc hand-off instead of chsh for zsh switch
chsh is blocked on the corp dev VM (PAM-level restriction at user-
provisioning time). Drop the sudo chsh -s call from 20-zsh.sh and
append a guarded `exec zsh -l` block to ~/.bashrc instead — same UX
without needing infra escalation, also matches the legacy WSL setup
pattern in 02-wsl-terminal-setup.md.

The hand-off is guarded by `case $- in *i*)` so non-interactive bash
flows (scp, rsync, cron) are unaffected, and by a ZSH_VERSION absence
check to prevent re-exec loops.

Main doc and README table descriptions updated to match.
2026-05-24 19:42:18 +02:00

5.8 KiB

Setup guides

Step-by-step setup procedures for new contributors. Each file is self-contained and idempotent — they document the state a developer should reach, not the order in which it must be done.

# File Audience
01 Debian 13 dev-VM setup Default — a dev who has just received a fresh dev VM from the infra team. Covers the full path: zsh + Oh My Zsh + Powerlevel10k, modern CLI tooling, Node via nvm, Docker CE, system tuning, optional VM hardening, project clones, the two IDE flows (VSCode Remote-SSH and Devcontainer), the hybrid (local + VM) mode.
02 WSL terminal setup Legacy — the original Windows-WSL flow. Kept for reference for devs still on that path until the org migrates to the VM-based flow.
03 Dev web stack Notes on the web-side tooling.
04 Angular + Nx monorepo Reference notes on the Angular + Nx workspace layout.

scripts/

Modular setup scripts called from the doc above. Each is idempotent, each can be re-run safely. Run via the orchestrator (bootstrap.sh) or individually.

Script Purpose
bootstrap.sh Run every numbered script in order with a confirmation prompt at each step.
lib.sh Common helpers — colour logging, idempotent apt_install / ensure_line.
10-base-packages.sh apt + base packages every other script assumes (curl wget git build-essential …).
20-zsh.sh zsh + Oh My Zsh + Powerlevel10k + autosuggestions + syntax-highlighting. Patches ~/.zshrc (theme / plugins / fzf hook) and ~/.bashrc (exec zsh — chsh blocked on corp VM).
30-cli-tools.sh bat eza fd-find ripgrep fzf zoxide ncdu keychain + dev extras (jq yq httpie make tree htop tmux direnv).
40-node.sh nvm + Node from the repo's .nvmrc + corepack pinned to package.json#packageManager's pnpm version.
50-docker.sh Docker CE + compose plugin from docker.com apt repo + user added to docker group + service enabled at boot.
60-tuning.sh inotify watches → 524288, optional 4 GB swapfile, optional hostname rename (only prompts if generic).
70-hardening.sh Best-effort UFW + unattended-upgrades + fail2ban + sshd hardening drop-in. Probes before applying — skips done items.
80-dotfiles.sh Symlinks notes/aliases.zsh~/.oh-my-zsh/custom/aliases.zsh. Copies notes/gitconfig.txt to ~/.gitconfig with prompted identity.

systemd/

File Purpose
apf-portal-infra@.service Template unit auto-starting ./infra/local/dev.sh up at boot for a given user.