diff --git a/.forgejo/workflows/deploy-docs.yml b/.forgejo/workflows/deploy-docs.yml index 611aa94..c488711 100644 --- a/.forgejo/workflows/deploy-docs.yml +++ b/.forgejo/workflows/deploy-docs.yml @@ -4,7 +4,7 @@ name: Deploy docs on: push: branches: - - release-* + - release-25.11 jobs: build-and-deploy: @@ -19,5 +19,8 @@ jobs: STORE_PATH=$(nix build .#synix-docs --print-out-paths --no-link) echo "STORE_PATH=$STORE_PATH" >> $GITHUB_ENV + - name: Check external links + run: nix run nixpkgs#lychee -- --exclude-loopback docs/ + - name: Update symlink run: ln -sfn ${{ env.STORE_PATH }} /var/www/doc diff --git a/docs/getting-started/add-configs.md b/docs/getting-started/add-configs.md index 006bf3c..3b49a5a 100644 --- a/docs/getting-started/add-configs.md +++ b/docs/getting-started/add-configs.md @@ -1,6 +1,6 @@ # Add NixOS and Home Manager configurations -Choose a configuration template from [this list](https://git.sid.ovh/sid/synix/tree/master/apps/create/templates). +Choose a configuration template from [this list](https://git.sid.ovh/sid/synix/src/branch/release-25.11/templates/nix-configs). Run the `create` script to add your desired configuration template to your nix-config flake: @@ -14,7 +14,7 @@ nix --experimental-features "nix-command flakes" run git+https://git.sid.ovh/sid -f ~/.config/nixos ``` -> Change the architecture if needed. Supported architectures are listet under `supportedSystems` inside [`flake.nix`](https://git.sid.ovh/sid/synix/blob/master/flake.nix). +> Change the architecture if needed. Supported architectures are listet under `supportedSystems` inside [`flake.nix`](https://git.sid.ovh/sid/synix/src/branch/release-25.11/flake.nix). See the script's help page for reference: diff --git a/docs/getting-started/create-nix-config.md b/docs/getting-started/create-nix-config.md index a96bd5e..ad31cc9 100644 --- a/docs/getting-started/create-nix-config.md +++ b/docs/getting-started/create-nix-config.md @@ -1,6 +1,6 @@ # Create your own nix-config flake -Create an empty directory and apply a [nix-config template](https://git.sid.ovh/sid/synix/tree/master/templates/nix-config) to it: +Create an empty directory and apply a [nix-config template](https://git.sid.ovh/sid/synix/src/branch/release-25.11/templates/nix-configs) to it: ```bash mkdir -p ~/.config/nixos diff --git a/docs/getting-started/install-instructions.md b/docs/getting-started/install-instructions.md index b1407f7..9bdafb0 100644 --- a/docs/getting-started/install-instructions.md +++ b/docs/getting-started/install-instructions.md @@ -1,6 +1,6 @@ # Installation Guide -This guide will walk you through installing NixOS using the provided installation script [`install.sh`](https://git.sid.ovh/sid/synix/blob/master/apps/install/install.sh). +This guide will walk you through installing NixOS using the provided installation script [`install.sh`](https://git.sid.ovh/sid/synix/src/branch/release-25.11/apps/install/install.sh). ## Prerequisites diff --git a/docs/modules/home/bemenu.md b/docs/modules/home/bemenu.md index d661c58..9ebe67b 100644 --- a/docs/modules/home/bemenu.md +++ b/docs/modules/home/bemenu.md @@ -2,7 +2,7 @@ `bemenu` is a dynamic menu library and client program inspired by dmenu. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/bemenu). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/bemenu). If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default. ## References diff --git a/docs/modules/home/common.md b/docs/modules/home/common.md index 0334bfc..22e93cb 100644 --- a/docs/modules/home/common.md +++ b/docs/modules/home/common.md @@ -2,7 +2,7 @@ The common module sets some opinionated defaults. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/common). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/common). It is recommended to import it in your Home Manager configuration as some synix modules may depend on it: diff --git a/docs/modules/home/gemini-cli.md b/docs/modules/home/gemini-cli.md deleted file mode 100644 index 02a26a8..0000000 --- a/docs/modules/home/gemini-cli.md +++ /dev/null @@ -1,65 +0,0 @@ -# Gemini CLI - -An open-source AI agent that brings the power of Gemini directly into your terminal. - -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/gemini-cli). - -## References - -- [GitHub](https://github.com/google-gemini/gemini-cli) -- [CLI Docs](https://github.com/google-gemini/gemini-cli/tree/main/docs/cli) - -## Setup - -The package must be set by you. Easiest option is to use the synix overlay: - -```nix -{ inputs, pkgs, ... }: - -{ - imports = [ - inputs.synix.homeModules.gemini-cli - ]; - - programs.gemini-cli = { - enable = true; - package = pkgs.synix.gemini-cli; - }; -} -``` - -Gemini CLI reads environment variables, such as your API key, from `~/.gemini/.env`. You can manage it with sops-nix: - -```nix -{ config, ... }: - -{ - sops.secrets.gemini-api-key = { }; - sops.templates.gemini-cli-env = { - content = '' - GEMINI_API_KEY=${config.sops.placeholder.gemini-api-key} - ''; - path = config.home.homeDirectory + "/.gemini/.env"; - }; -} -``` - -Set `gemini-api-key` in your `secrets.yaml`: - -> Replace `abc123` with your Gemini API key. - -```yaml -gemini-api-key: abc123 -``` - -## Troubleshooting - -These are some common warnings and errors you might encounter when using Gemini CLI: - -### Error saving user settings file - -``` -Error saving user settings file: Error: EROFS: read-only file system, open '/home/you/.gemini/settings.json' -``` - -This is intended behavior. diff --git a/docs/modules/home/gpg.md b/docs/modules/home/gpg.md index 5f613fc..35272f6 100644 --- a/docs/modules/home/gpg.md +++ b/docs/modules/home/gpg.md @@ -2,7 +2,7 @@ This module sets some defaults for gpg, mainly to let your gpg-agent handle ssh keys. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/gpg). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/gpg). ## SSH Setup diff --git a/docs/modules/home/hyprland.md b/docs/modules/home/hyprland.md index 38102a8..b460322 100644 --- a/docs/modules/home/hyprland.md +++ b/docs/modules/home/hyprland.md @@ -6,17 +6,17 @@ This module extends the options of and sets some defaults for [Hyprland](https:/ - XDG mime support and user directories - enable Waybar as status bar - enable dunst as notification service -- some [packages](https://git.sid.ovh/sid/synix/blob/master/modules/home/hyprland/packages.nix) -- [keybindings](https://git.sid.ovh/sid/synix/blob/master/modules/home/hyprland/binds/default.nix) +- some [packages](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/hyprland/packages.nix) +- [keybindings](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/hyprland/binds/default.nix) - manage default applications via the new `applications` option > Always import both NixOS and Home Manager modules from `synix` when using Hyprland. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/hyprland). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/hyprland). ## Keybindings -The ["Master Layout"](https://wiki.hyprland.org/Configuring/Master-Layout/) is the only supported window layout. +The ["Master Layout"](https://wiki.hypr.land/Configuring/Layouts/Master-Layout/) is the only supported window layout. > `$mod`, `modifier` or `SUPER` refer to the same key which is the Windows key by default. @@ -59,7 +59,7 @@ Keybinding | Function `SUPER LMB` | Move window by dragging `SUPER RMB` | Resize window by dragging -Some [media keys](https://git.sid.ovh/sid/synix/blob/master/modules/home/hyprland/binds/mediakeys.nix) are also supported. +Some [media keys](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/hyprland/binds/mediakeys.nix) are also supported. ## Default applications @@ -73,7 +73,7 @@ To add default applications to Hyprland, you need to do the following steps: ### 1. Look for an existing category -Check if a fitting category for your application exists in [`applications/default.nix`](https://git.sid.ovh/sid/synix/blob/master/modules/home/hyprland/applications/default.nix). +Check if a fitting category for your application exists in [`applications/default.nix`](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/hyprland/applications/default.nix). Categories are listed under `options.wayland.windowManager.hyprland.applications`, for example: ```nix @@ -133,13 +133,13 @@ in } ``` -> The function [`genMimeAssociations`](https://git.sid.ovh/sid/synix/blob/master/modules/home/hyprland/applications/genMimeAssociations.nix) might be useful here. See [`feh`'s config](https://git.sid.ovh/sid/synix/blob/master/modules/home/hyprland/applications/feh/default.nix) as an example. +> The function [`genMimeAssociations`](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/hyprland/applications/genMimeAssociations.nix) might be useful here. See [`feh`'s config](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/hyprland/applications/feh/default.nix) as an example. > Available MIME types can be found [here](https://www.iana.org/assignments/media-types/media-types.xhtml). ### 3. Import the directory -You then need to import this directory in [`applications/default.nix`](https://git.sid.ovh/sid/synix/blob/master/modules/home/hyprland/applications/default.nix). +You then need to import this directory in [`applications/default.nix`](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/hyprland/applications/default.nix). Look for the comment `# add your application directories here`: ```nix diff --git a/docs/modules/home/kitty.md b/docs/modules/home/kitty.md index 592fbdb..8783c9a 100644 --- a/docs/modules/home/kitty.md +++ b/docs/modules/home/kitty.md @@ -2,7 +2,7 @@ `kitty` is a cross-platform, fast, feature-rich, GPU based terminal emulator. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/kitty). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/kitty). If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default. ## References diff --git a/docs/modules/home/lf.md b/docs/modules/home/lf.md deleted file mode 100644 index ef7a2b6..0000000 --- a/docs/modules/home/lf.md +++ /dev/null @@ -1,11 +0,0 @@ -# lf - -> Note: This module is not actively maintained. Expect things to break! - -`lf` is a terminal file manager. - -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/lf). - -## References - -- [GitHub](https://github.com/gokcehan/lf) diff --git a/docs/modules/home/networkmanager-dmenu.md b/docs/modules/home/networkmanager-dmenu.md index 0415c1d..0131502 100644 --- a/docs/modules/home/networkmanager-dmenu.md +++ b/docs/modules/home/networkmanager-dmenu.md @@ -2,7 +2,7 @@ networkmanager-dmenu allows you to control NetworkManager via dmenu. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/networkmanager-dmenu). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/networkmanager-dmenu). If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default. ## References diff --git a/docs/modules/home/nextcloud-sync.md b/docs/modules/home/nextcloud-sync.md deleted file mode 100644 index bea2110..0000000 --- a/docs/modules/home/nextcloud-sync.md +++ /dev/null @@ -1,75 +0,0 @@ -# Nextcloud sync client - -Because every other client sucks. - -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/nextcloud-sync). - -## Setup - -This is an example home config: - -```nix -{ inputs, config, ... }: - -{ - imports = [ - inputs.synix.homeModules.nextcloud-sync - ]; - - services.nextcloud-sync = { - enable = true; - remote = "cloud.sid.ovh"; # just the URL without `https://` - passwordFile = config.sops.secrets.nextcloud.path; - connections = [ # absolute paths without trailing / - { - local = "/home/sid/aud"; - remote = "/aud"; - } - { - local = "/home/sid/doc"; - remote = "/doc"; - } - { - local = "/home/sid/img"; - remote = "/img"; - } - { - local = "/home/sid/vid"; - remote = "/vid"; - } - ]; - }; -} -``` - -## Usage - -You can manually sync by running: - -```bash -nextcloud-sync-all -``` - -This will synchronize all defined connections. - -## Troubleshooting - -Each listed connection spawns a systemd user service and timer. Using the example above, we get: - -```plaintext -nextcloud-sync-aud.service -nextcloud-sync-aud.timer -nextcloud-sync-doc.service -nextcloud-sync-doc.timer -nextcloud-sync-img.service -nextcloud-sync-img.timer -nextcloud-sync-vid.service -nextcloud-sync-vid.timer -``` - -Check their status to know what might go wrong: - -```bash -systemctl --user status nextcloud-sync-doc.service -journalctl --user -xeu nextcloud-sync-doc.service -``` diff --git a/docs/modules/home/nixvim.md b/docs/modules/home/nixvim.md index 01e613d..701af63 100644 --- a/docs/modules/home/nixvim.md +++ b/docs/modules/home/nixvim.md @@ -2,7 +2,7 @@ This module provides some defaults to quickly set up Nixvim with some plugins. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/nixvim). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/nixvim). ## Config @@ -88,7 +88,7 @@ key | action `` | next quickfix item `ca` | apply code action -See [keymaps.nix](https://git.sid.ovh/sid/synix/blob/master/modules/home/nixvim/keymaps.nix) and [plugins](https://git.sid.ovh/sid/synix/blob/master/modules/home/nixvim/plugins/) for more details. +See [keymaps.nix](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/nixvim/keymaps.nix) and [plugins](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/nixvim/plugins/) for more details. These commands do not have keymaps yet but might be useful anyway: diff --git a/docs/modules/home/password-manager.md b/docs/modules/home/password-manager.md index a67db88..b0d9487 100644 --- a/docs/modules/home/password-manager.md +++ b/docs/modules/home/password-manager.md @@ -2,7 +2,7 @@ This module will automatically install [`pass`](https://www.passwordstore.org/) as your password manager. It also provides a custom version of [`passmenu`](https://git.zx2c4.com/password-store/tree/contrib/dmenu/passmenu) using `bemenu` for Wayland sessions called `passmenu-bemenu` and configures [passff](https://codeberg.org/PassFF/passff) for your web browser. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/password-manager). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/password-manager). ## Setup diff --git a/docs/modules/home/sops.md b/docs/modules/home/sops.md index 5cb973e..a6227ef 100644 --- a/docs/modules/home/sops.md +++ b/docs/modules/home/sops.md @@ -4,7 +4,7 @@ For more information on how to use this module, see the [Sops NixOS module docum For extensive documentation, read the [Readme on GitHub](https://github.com/Mic92/sops-nix/blob/master/README.md). -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/sops). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/sops). ## 1. Generate an age key diff --git a/docs/modules/home/stylix.md b/docs/modules/home/stylix.md index 2c09718..6580846 100644 --- a/docs/modules/home/stylix.md +++ b/docs/modules/home/stylix.md @@ -2,7 +2,7 @@ This module wraps [stylix](https://github.com/nix-community/stylix), a theming framework for NixOS, Home Manager, nix-darwin, and Nix-on-Droid. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/stylix). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/stylix). ## References @@ -30,11 +30,11 @@ stylix = { }; ``` -Replace `SCHEME` with the name of your scheme. Available schemes are listed as `validSchemes` in [our stylix module](https://git.sid.ovh/sid/synix/tree/master/modules/home/stylix/default.nix). +Replace `SCHEME` with the name of your scheme. Available schemes are listed as `validSchemes` in [our stylix module](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/stylix/default.nix). ## Create a scheme -You can create your own scheme in `schemes/.yaml`. To make it available via `stylix.scheme`, you need to add it to `validSchemes` and `customSchemes` in [the module's `default.nix`](https://git.sid.ovh/sid/synix/tree/master/modules/home/stylix/default.nix). Make sure that the resulting scheme name is a valid [colorscheme in nixvim](https://github.com/nix-community/nixvim/tree/main/plugins/colorschemes). +You can create your own scheme in `schemes/.yaml`. To make it available via `stylix.scheme`, you need to add it to `validSchemes` and `customSchemes` in [the module's `default.nix`](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/stylix/default.nix). Make sure that the resulting scheme name is a valid [colorscheme in nixvim](https://github.com/nix-community/nixvim/tree/main/colorschemes). It is recommended to set colors according to their purpose / name. This means that `base00` should always be a rather dark color for the background and `base08` a reddish color. diff --git a/docs/modules/home/virtualisation.md b/docs/modules/home/virtualisation.md index 5f6ec54..4776d23 100644 --- a/docs/modules/home/virtualisation.md +++ b/docs/modules/home/virtualisation.md @@ -2,7 +2,7 @@ Home Manager module to go with the [Virtualisation NixOS module](../nixos/virtualisation.md). -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/virtualisation). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/virtualisation). ## Setup diff --git a/docs/modules/home/waybar.md b/docs/modules/home/waybar.md index 45ae43f..f19db13 100644 --- a/docs/modules/home/waybar.md +++ b/docs/modules/home/waybar.md @@ -2,7 +2,7 @@ Waybar is a highly customizable Wayland bar for Sway and Wlroots based compositors. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/waybar). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/waybar). If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default. ## References diff --git a/docs/modules/home/yazi.md b/docs/modules/home/yazi.md index f8154a5..d380441 100644 --- a/docs/modules/home/yazi.md +++ b/docs/modules/home/yazi.md @@ -2,7 +2,7 @@ Terminal file manager written in Rust. -View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/yazi). +View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/home/hyprland/applications/yazi). If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default. ## References diff --git a/docs/modules/nixos/audio.md b/docs/modules/nixos/audio.md index ff61a31..657d0db 100644 --- a/docs/modules/nixos/audio.md +++ b/docs/modules/nixos/audio.md @@ -2,7 +2,7 @@ PipeWire is a server for handling audio, video streams, and hardware on Linux. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/audio). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/audio). ## References diff --git a/docs/modules/nixos/baibot.md b/docs/modules/nixos/baibot.md index 31658ea..cabbb85 100644 --- a/docs/modules/nixos/baibot.md +++ b/docs/modules/nixos/baibot.md @@ -2,7 +2,7 @@ Baibot is a Matrix AI bot. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/baibot). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/baibot). ## References diff --git a/docs/modules/nixos/cifsmount.md b/docs/modules/nixos/cifsmount.md index 31f22bb..9cb34a1 100644 --- a/docs/modules/nixos/cifsmount.md +++ b/docs/modules/nixos/cifsmount.md @@ -4,7 +4,7 @@ This module allows you to automount cifs shares after the login of the specified user. The remote has to have a running samba server. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/cifsMount). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/cifsMount). ## Config diff --git a/docs/modules/nixos/common.md b/docs/modules/nixos/common.md index df82663..df2f8ed 100644 --- a/docs/modules/nixos/common.md +++ b/docs/modules/nixos/common.md @@ -2,7 +2,7 @@ The common module sets some opinionated defaults. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/common). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/common). It is recommended to import it in your NixOS configuration as some synix modules may depend on it: diff --git a/docs/modules/nixos/device.md b/docs/modules/nixos/device.md index 44f021f..b2b38ab 100644 --- a/docs/modules/nixos/device.md +++ b/docs/modules/nixos/device.md @@ -2,7 +2,7 @@ This module lets you set some defaults for a device type. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/device). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/device). Available devices are: diff --git a/docs/modules/nixos/ftp-webserver.md b/docs/modules/nixos/ftp-webserver.md index 3b2c3f0..2b6f4d1 100644 --- a/docs/modules/nixos/ftp-webserver.md +++ b/docs/modules/nixos/ftp-webserver.md @@ -4,4 +4,4 @@ This module sets up a simple ftp web server behind a reverse proxy (`ftp.domain.tld` by default). -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/ftp-webserver). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/ftp-webserver). diff --git a/docs/modules/nixos/headplane.md b/docs/modules/nixos/headplane.md index d127125..2cc4c92 100644 --- a/docs/modules/nixos/headplane.md +++ b/docs/modules/nixos/headplane.md @@ -2,7 +2,7 @@ A feature-complete Web UI for Headscale. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/headplane). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/headplane). ## References diff --git a/docs/modules/nixos/headscale.md b/docs/modules/nixos/headscale.md index 0842ac5..393bb66 100644 --- a/docs/modules/nixos/headscale.md +++ b/docs/modules/nixos/headscale.md @@ -2,7 +2,7 @@ Headscale is an open source, self-hosted implementation of the Tailscale control server. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/headscale). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/headscale). ## References diff --git a/docs/modules/nixos/i2pd.md b/docs/modules/nixos/i2pd.md index ce33e93..6e054c5 100644 --- a/docs/modules/nixos/i2pd.md +++ b/docs/modules/nixos/i2pd.md @@ -2,7 +2,7 @@ I2P is an End-to-End encrypted and anonymous Internet. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/i2pd). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/i2pd). ## References diff --git a/docs/modules/nixos/jellyfin.md b/docs/modules/nixos/jellyfin.md index 930c3d6..9e4f343 100644 --- a/docs/modules/nixos/jellyfin.md +++ b/docs/modules/nixos/jellyfin.md @@ -2,7 +2,7 @@ Jellyfin is a free and open-source media server and suite of multimedia applications. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/jellyfin). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/jellyfin). ## References diff --git a/docs/modules/nixos/jirafeau.md b/docs/modules/nixos/jirafeau.md index b1fa844..de2bedf 100644 --- a/docs/modules/nixos/jirafeau.md +++ b/docs/modules/nixos/jirafeau.md @@ -2,8 +2,8 @@ Jirafeau is a project that allows "one-click filesharing", making it easy to upload a file and give it a unique link. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/jirafeau). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/jirafeau). ## References -- [docs](https://github.com/Newlode/jirafeauhttps://github.com/Newlode/jirafeau) +- [docs](https://github.com/Newlode/jirafeau) diff --git a/docs/modules/nixos/mailserver.md b/docs/modules/nixos/mailserver.md index b6bf41d..31bcfaf 100644 --- a/docs/modules/nixos/mailserver.md +++ b/docs/modules/nixos/mailserver.md @@ -2,7 +2,7 @@ A simple NixOS mailserver. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/mailserver). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/mailserver). ## References diff --git a/docs/modules/nixos/matrix-synapse.md b/docs/modules/nixos/matrix-synapse.md index a106122..3399d77 100644 --- a/docs/modules/nixos/matrix-synapse.md +++ b/docs/modules/nixos/matrix-synapse.md @@ -2,7 +2,7 @@ Synapse is a [Matrix](https://matrix.org/) homeserver. Matrix is an open network for secure, decentralised communication. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/matrix-synapse). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/matrix-synapse). ## References @@ -40,7 +40,7 @@ nix-shell -p livekit --run "livekit-server generate-keys | tail -1 | awk '{print ## Config -[Coturn has its own module](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/matrix-synapse), making it easy to outsource to a small VPS with a static IPv4 address. +[Coturn has its own module](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/matrix-synapse), making it easy to outsource to a small VPS with a static IPv4 address. If you do so, both machines need the secret `coturn/static-auth-secret`. In the following example, both services run on the same machine: diff --git a/docs/modules/nixos/maubot.md b/docs/modules/nixos/maubot.md index 8e8a9a6..969a72a 100644 --- a/docs/modules/nixos/maubot.md +++ b/docs/modules/nixos/maubot.md @@ -4,7 +4,7 @@ A plugin-based Matrix bot system. > Warning: Maubot uses [deprecated `libolm`](https://github.com/mautrix/go/issues/262). -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/maubot). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/maubot). ## References diff --git a/docs/modules/nixos/mcpo.md b/docs/modules/nixos/mcpo.md index c5cb701..4ef6cfc 100644 --- a/docs/modules/nixos/mcpo.md +++ b/docs/modules/nixos/mcpo.md @@ -2,7 +2,7 @@ A simple MCP-to-OpenAPI proxy server. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/mcpo). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/mcpo). ## References @@ -10,7 +10,7 @@ View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/ma ## Configuration -You have to provide a package, for example from [synix](https://git.sid.ovh/sid/synix/tree/master/pkgs/mcpo/default.nix). +You have to provide a package, for example from [synix](https://git.sid.ovh/sid/synix/src/branch/release-25.11/pkgs/mcpo/default.nix). Setting `mcpServers` is required. The following example runs a NixOS MCP server using [mcp-nixos](https://github.com/utensils/mcp-nixos). @@ -43,6 +43,6 @@ Each tool will be accessible under its own unique route `127.0.0.1:8000/ *General* > *Advanced Parameters*. Then, they can enable MCP servers in a chat by clicking *More* (the plus sign) in the bottom left of the prompt window. diff --git a/docs/modules/nixos/miniflux.md b/docs/modules/nixos/miniflux.md index 628bdcf..255c8e3 100644 --- a/docs/modules/nixos/miniflux.md +++ b/docs/modules/nixos/miniflux.md @@ -2,7 +2,7 @@ Miniflux is a minimalist and opinionated feed reader. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/miniflux). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/miniflux). ## References diff --git a/docs/modules/nixos/normalUsers.md b/docs/modules/nixos/normalUsers.md index 308841b..03fd0c3 100644 --- a/docs/modules/nixos/normalUsers.md +++ b/docs/modules/nixos/normalUsers.md @@ -2,7 +2,7 @@ This module automates user creation for normal users. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/normalUsers). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/normalUsers). ## Config diff --git a/docs/modules/nixos/nvidia.md b/docs/modules/nixos/nvidia.md index 7851abe..78d6d8e 100644 --- a/docs/modules/nixos/nvidia.md +++ b/docs/modules/nixos/nvidia.md @@ -4,7 +4,7 @@ NixOS module that configures your Nvidia GPU with proprietary drivers. > Tested on Turing and Ampere. Should work with most modern Nvidia GPUs. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/nvidia). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/nvidia). ## Setup diff --git a/docs/modules/nixos/open-webui-oci.md b/docs/modules/nixos/open-webui-oci.md index 17bd06b..01424f0 100644 --- a/docs/modules/nixos/open-webui-oci.md +++ b/docs/modules/nixos/open-webui-oci.md @@ -2,13 +2,13 @@ Open WebUI is an extensible, self-hosted AI interface that adapts to your workflow, all while operating entirely offline. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/open-webui-oci). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/open-webui-oci). ## References - [Homepage](https://openwebui.com/) - [GitHub](https://github.com/open-webui/open-webui) -- [Environment Configuration](https://docs.openwebui.com/getting-started/env-configuration/) +- [Environment Configuration](https://docs.openwebui.com/reference/env-configuration/) - [Nixpkgs Docker tools](https://github.com/NixOS/nixpkgs/blob/master/doc/build-helpers/images/dockertools.section.md) ## Configuration diff --git a/docs/modules/nixos/print-server.md b/docs/modules/nixos/print-server.md index cc7c56d..c8c384b 100644 --- a/docs/modules/nixos/print-server.md +++ b/docs/modules/nixos/print-server.md @@ -4,4 +4,4 @@ This module sets up a printing server with a web interface. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/print-server). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/print-server). diff --git a/docs/modules/nixos/radicale.md b/docs/modules/nixos/radicale.md index b0cc8c7..3c9cef2 100644 --- a/docs/modules/nixos/radicale.md +++ b/docs/modules/nixos/radicale.md @@ -2,7 +2,7 @@ A simple CalDAV and CardDAV server. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/radicale). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/radicale). ## References diff --git a/docs/modules/nixos/rss-bridge.md b/docs/modules/nixos/rss-bridge.md index fc9d004..9ad4744 100644 --- a/docs/modules/nixos/rss-bridge.md +++ b/docs/modules/nixos/rss-bridge.md @@ -2,7 +2,7 @@ RSS-Bridge is a PHP web application. It generates web feeds for websites that don't have one. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/rss-bridge). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/rss-bridge). ## References diff --git a/docs/modules/nixos/sops.md b/docs/modules/nixos/sops.md index d37ae19..47a3cfe 100644 --- a/docs/modules/nixos/sops.md +++ b/docs/modules/nixos/sops.md @@ -2,7 +2,7 @@ Atomic secret provisioning for NixOS based on sops. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/sops). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/sops). ## References diff --git a/docs/modules/nixos/virtualisation.md b/docs/modules/nixos/virtualisation.md index 5ef0e0b..545cafe 100644 --- a/docs/modules/nixos/virtualisation.md +++ b/docs/modules/nixos/virtualisation.md @@ -2,7 +2,7 @@ Virtualisation using QEMU via libvirt and managed through Virt-manager with VFIO support. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/virtualisation). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/virtualisation). ## Overview diff --git a/docs/modules/nixos/webpage.md b/docs/modules/nixos/webpage.md index 1a79e73..c729d95 100644 --- a/docs/modules/nixos/webpage.md +++ b/docs/modules/nixos/webpage.md @@ -2,4 +2,4 @@ A very simple module to serve a static web page behind a reverse proxy using nginx. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/webPage). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/webPage). diff --git a/docs/modules/nixos/windows-oci.md b/docs/modules/nixos/windows-oci.md index 388d6f5..1cf1af2 100644 --- a/docs/modules/nixos/windows-oci.md +++ b/docs/modules/nixos/windows-oci.md @@ -2,7 +2,7 @@ Windows inside a Docker container. -View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/nixos/windows-oci). +View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/src/branch/release-25.11/modules/nixos/windows-oci). ## References diff --git a/flake.nix b/flake.nix index c52228e..881b6ab 100644 --- a/flake.nix +++ b/flake.nix @@ -152,6 +152,7 @@ nativeBuildInputs = [ enabledPackages pkgs.nix + pkgs.lychee ] ++ (with pkgs; [ (python313.withPackages ( diff --git a/mkdocs.yml b/mkdocs.yml index 9f305c0..9cce0c5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,7 +68,6 @@ nav: - hyprland: modules/home/hyprland.md - kitty: modules/home/kitty.md - networkmanager-dmenu: modules/home/networkmanager-dmenu.md - - nextcloud-sync: modules/home/nextcloud-sync.md - nixvim: modules/home/nixvim.md - password-manager: modules/home/password-manager.md - sops: modules/home/sops.md