From a31369fea86aae4024f144cdd614b16059384532 Mon Sep 17 00:00:00 2001 From: Padreug Date: Sun, 28 Jun 2026 11:45:27 +0200 Subject: [PATCH] docs: point template + install docs at the real Omnixient repo Replace the placeholders with the actual public URL (git+https://git.atitlan.io/aiolabs/omnixient, https so forkers need no SSH), and switch the packs standalone-import example from git+ssh to the same https URL. Co-Authored-By: Claude Opus 4.8 --- docs/getting-started.md | 10 +++++----- docs/packs.md | 2 +- templates/default/README.md | 4 ++-- templates/default/flake.nix | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 360c8e3..f747b3e 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -33,7 +33,7 @@ You update it like any dependency; it never touches your files. ## 1. Scaffold your config ```bash -nix flake init -t github:/omnixient # writes flake.nix + hosts/myhost/ +nix flake init -t git+https://git.atitlan.io/aiolabs/omnixient # writes flake.nix + hosts/myhost/ cd ``` @@ -41,7 +41,7 @@ This drops a starter that already wires `omni.lib.mkSystem` + `omni.nixosModules.omni`. Open `flake.nix` and: - set `omni.url` to the real repo (pin a tag for reproducibility, e.g. - `github:/omnixient/v1.0.0`); + `git+https://git.atitlan.io/aiolabs/omnixient?ref=v1.0.0`); - fill in the `settings` block: ```nix @@ -167,7 +167,7 @@ sudo nixos-rebuild switch --flake .#myhost This **can't** conflict with your config — Omnixient is a pinned dependency, not a checkout. Roll back by reverting `flake.lock`; pin a release with -`omni.url = "github:/omnixient/v1.0.0"`. +`omni.url = "git+https://git.atitlan.io/aiolabs/omnixient?ref=v1.0.0"`. --- @@ -206,7 +206,7 @@ it never gets in your way until you ask for it. ## Building a custom ISO (optional) -From an Omnixient checkout (or `nix build github:/omnixient#omni-iso`): +From an Omnixient checkout (or `nix build git+https://git.atitlan.io/aiolabs/omnixient#omni-iso`): ```bash nix build .#omni-iso # → result/iso/nixos-*.iso @@ -222,7 +222,7 @@ If you want to modify Omnixient's own modules/themes rather than just consume them, fork the repo and edit in place: ```bash -git clone https://github.com//omnixient.git ~/omni && cd ~/omni +git clone https://git.atitlan.io/aiolabs/omnixient.git ~/omni && cd ~/omni ``` Then model a host on **`hosts/example/`** (copy it to `hosts//`, diff --git a/docs/packs.md b/docs/packs.md index 6d3fdbd..7885e9c 100644 --- a/docs/packs.md +++ b/docs/packs.md @@ -93,7 +93,7 @@ flake as an input and import just the pack you want: ```nix # your own flake.nix -inputs.omni.url = "git+ssh://forgejo@git.atitlan.io/aiolabs/omnixient"; +inputs.omni.url = "git+https://git.atitlan.io/aiolabs/omnixient"; # your host's modules { diff --git a/templates/default/README.md b/templates/default/README.md index 0911b43..a489726 100644 --- a/templates/default/README.md +++ b/templates/default/README.md @@ -1,6 +1,6 @@ # My Omnixient config -Generated from Omnixient's starter template (`nix flake init -t github:/omnixient`). +Generated from Omnixient's starter template (`nix flake init -t git+https://git.atitlan.io/aiolabs/omnixient`). You consume Omnixient as a flake **input** — you do not fork it — so `nix flake update omni` pulls upstream changes without ever touching your files. @@ -32,7 +32,7 @@ sudo nixos-rebuild switch --flake .#myhost This can't conflict with your config — Omnixient is an input, not a checkout. Roll back by reverting `flake.lock`. Pin a release with -`omni.url = "github:/omnixient/v1.0.0"`. +`omni.url = "git+https://git.atitlan.io/aiolabs/omnixient?ref=v1.0.0"`. ## Secrets (optional) diff --git a/templates/default/flake.nix b/templates/default/flake.nix index 19d5232..d8e0c28 100644 --- a/templates/default/flake.nix +++ b/templates/default/flake.nix @@ -5,7 +5,7 @@ # Pin Omnixient. Point this at the canonical repo or your own fork, and # ideally pin a release tag (…/omni/v1.0.0) for reproducible updates: # nix flake update omni # pull the latest Omnixient, never touches your config - omni.url = "github:/omnixient"; + omni.url = "git+https://git.atitlan.io/aiolabs/omnixient"; # Reuse Omnixient's nixpkgs so you evaluate a single package set. nixpkgs.follows = "omni/nixpkgs"; };