sid/synix
1
0
Fork 0
Code Issues 6 Pull requests 1 Projects Activity Actions

Merge pull request 'develop' (#55) from develop into release-25.11
All checks were successful
Deploy docs / build-and-deploy (push) Successful in 26s
Details

Browse source 
Reviewed-on: #55
This commit is contained in:
sid 2026-05-31 20:34:50 +02:00
commit 09ad548f97
48 changed files with 63 additions and 211 deletions
Download patch file Download diff file Expand all files Collapse all files

5
.forgejo/workflows/deploy-docs.yml
View file

@ -4,7 +4,7 @@ name: Deploy docs
on: on:
push: push:
branches: branches:
- release-* - release-25.11
jobs: jobs:
build-and-deploy: build-and-deploy:
@ -19,5 +19,8 @@ jobs:
STORE_PATH=$(nix build .#synix-docs --print-out-paths --no-link) STORE_PATH=$(nix build .#synix-docs --print-out-paths --no-link)
echo "STORE_PATH=$STORE_PATH" >> $GITHUB_ENV echo "STORE_PATH=$STORE_PATH" >> $GITHUB_ENV
- name: Check external links
run: nix run nixpkgs#lychee -- --exclude-loopback docs/
- name: Update symlink - name: Update symlink
run: ln -sfn ${{ env.STORE_PATH }} /var/www/doc run: ln -sfn ${{ env.STORE_PATH }} /var/www/doc

4
docs/getting-started/add-configs.md
View file

@ -1,6 +1,6 @@
# Add NixOS and Home Manager configurations # 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: 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 -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: See the script's help page for reference:

2
docs/getting-started/create-nix-config.md
View file

@ -1,6 +1,6 @@
# Create your own nix-config flake # 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 ```bash
mkdir -p ~/.config/nixos mkdir -p ~/.config/nixos

2
docs/getting-started/install-instructions.md
View file

@ -1,6 +1,6 @@
# Installation Guide # 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 ## Prerequisites

2
docs/modules/home/bemenu.md
View file

@ -2,7 +2,7 @@
`bemenu` is a dynamic menu library and client program inspired by dmenu. `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. If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default.
## References ## References

2
docs/modules/home/common.md
View file

@ -2,7 +2,7 @@
The common module sets some opinionated defaults. 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: It is recommended to import it in your Home Manager configuration as some synix modules may depend on it:

65
docs/modules/home/gemini-cli.md
View file

@ -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.

2
docs/modules/home/gpg.md
View file

@ -2,7 +2,7 @@
This module sets some defaults for gpg, mainly to let your gpg-agent handle ssh keys. 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 ## SSH Setup

16
docs/modules/home/hyprland.md
View file

@ -6,17 +6,17 @@ This module extends the options of and sets some defaults for [Hyprland](https:/
- XDG mime support and user directories - XDG mime support and user directories
- enable Waybar as status bar - enable Waybar as status bar
- enable dunst as notification service - enable dunst as notification service
- some [packages](https://git.sid.ovh/sid/synix/blob/master/modules/home/hyprland/packages.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/blob/master/modules/home/hyprland/binds/default.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 - manage default applications via the new `applications` option
> Always import both NixOS and Home Manager modules from `synix` when using Hyprland. > 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 ## 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. > `$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 LMB` | Move window by dragging
`SUPER RMB` | Resize 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 ## 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 ### 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: Categories are listed under `options.wayland.windowManager.hyprland.applications`, for example:
```nix ```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). > Available MIME types can be found [here](https://www.iana.org/assignments/media-types/media-types.xhtml).
### 3. Import the directory ### 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`: Look for the comment `# add your application directories here`:
```nix ```nix

2
docs/modules/home/kitty.md
View file

@ -2,7 +2,7 @@
`kitty` is a cross-platform, fast, feature-rich, GPU based terminal emulator. `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. If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default.
## References ## References

11
docs/modules/home/lf.md
View file

@ -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)

2
docs/modules/home/networkmanager-dmenu.md
View file

@ -2,7 +2,7 @@
networkmanager-dmenu allows you to control NetworkManager via dmenu. 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. If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default.
## References ## References

75
docs/modules/home/nextcloud-sync.md
View file

@ -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
```

4
docs/modules/home/nixvim.md
View file

@ -2,7 +2,7 @@
This module provides some defaults to quickly set up Nixvim with some plugins. 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 ## Config
@ -88,7 +88,7 @@ key | action
`<C-A-K>` | next quickfix item `<C-A-K>` | next quickfix item
`<leader>ca` | apply code action `<leader>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: These commands do not have keymaps yet but might be useful anyway:

2
docs/modules/home/password-manager.md
View file

@ -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. 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 ## Setup

2
docs/modules/home/sops.md
View file

@ -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). 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 ## 1. Generate an age key

6
docs/modules/home/stylix.md
View file

@ -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. 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 ## 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 ## Create a scheme
You can create your own scheme in `schemes/<scheme>.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/<scheme>.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. 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.

2
docs/modules/home/virtualisation.md
View file

@ -2,7 +2,7 @@
Home Manager module to go with the [Virtualisation NixOS module](../nixos/virtualisation.md). 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 ## Setup

2
docs/modules/home/waybar.md
View file

@ -2,7 +2,7 @@
Waybar is a highly customizable Wayland bar for Sway and Wlroots based compositors. 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. If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default.
## References ## References

2
docs/modules/home/yazi.md
View file

@ -2,7 +2,7 @@
Terminal file manager written in Rust. 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. If you use this repository's [Hyprland module](./hyprland.md), it is enabled by default.
## References ## References

2
docs/modules/nixos/audio.md
View file

@ -2,7 +2,7 @@
PipeWire is a server for handling audio, video streams, and hardware on Linux. 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 ## References

2
docs/modules/nixos/baibot.md
View file

@ -2,7 +2,7 @@
Baibot is a Matrix AI bot. 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 ## References

2
docs/modules/nixos/cifsmount.md
View file

@ -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. 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 ## Config

2
docs/modules/nixos/common.md
View file

@ -2,7 +2,7 @@
The common module sets some opinionated defaults. 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: It is recommended to import it in your NixOS configuration as some synix modules may depend on it:

2
docs/modules/nixos/device.md
View file

@ -2,7 +2,7 @@
This module lets you set some defaults for a device type. 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: Available devices are:

2
docs/modules/nixos/ftp-webserver.md
View file

@ -4,4 +4,4 @@
This module sets up a simple ftp web server behind a reverse proxy (`ftp.domain.tld` by default). 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).

2
docs/modules/nixos/headplane.md
View file

@ -2,7 +2,7 @@
A feature-complete Web UI for Headscale. 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 ## References

2
docs/modules/nixos/headscale.md
View file

@ -2,7 +2,7 @@
Headscale is an open source, self-hosted implementation of the Tailscale control server. 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 ## References

2
docs/modules/nixos/i2pd.md
View file

@ -2,7 +2,7 @@
I2P is an End-to-End encrypted and anonymous Internet. 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 ## References

2
docs/modules/nixos/jellyfin.md
View file

@ -2,7 +2,7 @@
Jellyfin is a free and open-source media server and suite of multimedia applications. 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 ## References

4
docs/modules/nixos/jirafeau.md
View file

@ -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. 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 ## References
- [docs](https://github.com/Newlode/jirafeauhttps://github.com/Newlode/jirafeau) - [docs](https://github.com/Newlode/jirafeau)

2
docs/modules/nixos/mailserver.md
View file

@ -2,7 +2,7 @@
A simple NixOS mailserver. 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 ## References

4
docs/modules/nixos/matrix-synapse.md
View file

@ -2,7 +2,7 @@
Synapse is a [Matrix](https://matrix.org/) homeserver. Matrix is an open network for secure, decentralised communication. 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 ## References
@ -40,7 +40,7 @@ nix-shell -p livekit --run "livekit-server generate-keys | tail -1 | awk '{print
## Config ## 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`. If you do so, both machines need the secret `coturn/static-auth-secret`.
In the following example, both services run on the same machine: In the following example, both services run on the same machine:

2
docs/modules/nixos/maubot.md
View file

@ -4,7 +4,7 @@ A plugin-based Matrix bot system.
> Warning: Maubot uses [deprecated `libolm`](https://github.com/mautrix/go/issues/262). > 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 ## References

6
docs/modules/nixos/mcpo.md
View file

@ -2,7 +2,7 @@
A simple MCP-to-OpenAPI proxy server. 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 ## References
@ -10,7 +10,7 @@ View the [*synix* NixOS module on Forgejo](https://git.sid.ovh/sid/synix/tree/ma
## Configuration ## 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). 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/<mcp-ser
## Open WebUI Integration ## Open WebUI Integration
Follow the [official Open WebUI integration documentation starting at *Step 2*](https://docs.openwebui.com/openapi-servers/open-webui/#step-2-connect-tool-server-in-open-webui). Follow the [official Open WebUI integration documentation starting at *Step 2*](https://docs.openwebui.com/features/extensibility/plugin/tools/openapi-servers/open-webui#step-2-connect-tool-server-in-open-webui).
In Open WebUI, users have to set *Function Calling* to *Native* in *Settings* > *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. In Open WebUI, users have to set *Function Calling* to *Native* in *Settings* > *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.

2
docs/modules/nixos/miniflux.md
View file

@ -2,7 +2,7 @@
Miniflux is a minimalist and opinionated feed reader. 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 ## References

2
docs/modules/nixos/normalUsers.md
View file

@ -2,7 +2,7 @@
This module automates user creation for normal users. 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 ## Config

2
docs/modules/nixos/nvidia.md
View file

@ -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. > 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 ## Setup

4
docs/modules/nixos/open-webui-oci.md
View file

@ -2,13 +2,13 @@
Open WebUI is an extensible, self-hosted AI interface that adapts to your workflow, all while operating entirely offline. 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 ## References
- [Homepage](https://openwebui.com/) - [Homepage](https://openwebui.com/)
- [GitHub](https://github.com/open-webui/open-webui) - [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) - [Nixpkgs Docker tools](https://github.com/NixOS/nixpkgs/blob/master/doc/build-helpers/images/dockertools.section.md)
## Configuration ## Configuration

2
docs/modules/nixos/print-server.md
View file

@ -4,4 +4,4 @@
This module sets up a printing server with a web interface. 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).

2
docs/modules/nixos/radicale.md
View file

@ -2,7 +2,7 @@
A simple CalDAV and CardDAV server. 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 ## References

2
docs/modules/nixos/rss-bridge.md
View file

@ -2,7 +2,7 @@
RSS-Bridge is a PHP web application. It generates web feeds for websites that don't have one. 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 ## References

2
docs/modules/nixos/sops.md
View file

@ -2,7 +2,7 @@
Atomic secret provisioning for NixOS based on sops. 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 ## References

2
docs/modules/nixos/virtualisation.md
View file

@ -2,7 +2,7 @@
Virtualisation using QEMU via libvirt and managed through Virt-manager with VFIO support. 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 ## Overview

2
docs/modules/nixos/webpage.md
View file

@ -2,4 +2,4 @@
A very simple module to serve a static web page behind a reverse proxy using nginx. 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).

2
docs/modules/nixos/windows-oci.md
View file

@ -2,7 +2,7 @@
Windows inside a Docker container. 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 ## References

1
flake.nix
View file

@ -152,6 +152,7 @@
nativeBuildInputs = [ nativeBuildInputs = [
enabledPackages enabledPackages
pkgs.nix pkgs.nix
pkgs.lychee
] ]
++ (with pkgs; [ ++ (with pkgs; [
(python313.withPackages ( (python313.withPackages (

1
mkdocs.yml
View file

@ -68,7 +68,6 @@ nav:
- hyprland: modules/home/hyprland.md - hyprland: modules/home/hyprland.md
- kitty: modules/home/kitty.md - kitty: modules/home/kitty.md
- networkmanager-dmenu: modules/home/networkmanager-dmenu.md - networkmanager-dmenu: modules/home/networkmanager-dmenu.md
- nextcloud-sync: modules/home/nextcloud-sync.md
- nixvim: modules/home/nixvim.md - nixvim: modules/home/nixvim.md
- password-manager: modules/home/password-manager.md - password-manager: modules/home/password-manager.md
- sops: modules/home/sops.md - sops: modules/home/sops.md