config-central/README.md

72 lines
3.0 KiB
Markdown

# Config Central
Install the software and settings for a Windows desktop, then keep its configs
up to date with one command. No management server or background agent is needed.
## 1. Set up the computer once
Open **Windows PowerShell** as your normal desktop user and paste:
```powershell
irm 'https://proxy.dandaedre.com/gitea/Beffroi/config-central/raw/branch/main/install.ps1' | iex
```
The bundled machine profile is `beffroi-laptop`, selected automatically. If you
add more machines, setup matches the computer name or asks you to choose one. It installs
Git, PowerShell 7, and the declared software, then applies the configs. Approve
administrator prompts when needed. Existing managed settings are backed up and
replaced with repository versions. Rerun this command to repair setup.
Requires Windows 10 1809 or newer, Windows 11, or Windows Server 2025, with
internet access and support for WinGet.
## 2. Update configs whenever needed
Close the applications whose settings you are updating, then paste into
**PowerShell**:
```powershell
irm 'https://proxy.dandaedre.com/gitea/Beffroi/config-central/raw/branch/main/update-configs.ps1' | iex
```
This downloads the latest configs and updater code from your saved repository
branch and applies them to your saved machine profile. No menu, manual Git pull,
or software installation. Temporary downloads are removed afterward.
Unchanged configs are skipped. Local settings are backed up and replaced with
the repository versions by default. To preserve local edits instead, see
[advanced update options](docs/advanced_commands.md#web-config-updater).
Windows may request administrator approval for settings such as the hosts file.
## Collect settings from a computer
After changing settings in an application, close it and run in a new terminal:
```powershell
cc capture
```
The files are saved under
`Documents\ConfigCentral\captures\MACHINE-yyyyMMdd-HHmmss`.
Review them, copy the desired settings into this repository, then commit and
push. Run the update command on the other computers to receive those changes.
This includes Windows sound-event settings and the active power plan's battery
screen timeout. The repository defaults disable system sounds and keep the
screen on while on battery.
Capture does not upload anything automatically; some exports need curation.
See the [application config guide](docs/desktop-app-configs.md) for details.
## Troubleshooting and advanced use
Run `cc doctor` in a new terminal to check setup, or `cc status` to inspect the
last run and config drift. Status colors highlight failures (red), conflicts or
skips (yellow), completed work (green), and unchanged items (gray).
- [Advanced commands](docs/advanced_commands.md): profiles, packages, conflicts,
backups, schedules, and development checks.
- [Remote access from CachyOS](docs/advanced-remote-access.md): temporary debugging
shells and permanent SSH access.
- [Application configs](docs/desktop-app-configs.md): MPC-HC, Ontime, XnView MP,
Nextcloud, and hosts.