gador/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

treewide: Fix links in module documentation

Browse Source
This commit is contained in:
dish
2025-08-25 12:55:11 -04:00
parent 70d776e9fe
commit 970dcca69c
107 changed files with 180 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
nixos/modules/services/web-apps/castopod.md
View File

@@ -4,7 +4,7 @@ Castopod is an open-source hosting platform made for podcasters who want to enga
## Quickstart {#module-services-castopod-quickstart}
Configure ACME (https://nixos.org/manual/nixos/unstable/#module-security-acme).
Configure ACME (<https://nixos.org/manual/nixos/unstable/#module-security-acme>).
Use the following configuration to start a public instance of Castopod on `castopod.example.com` domain:
```nix

6
nixos/modules/services/web-apps/haven.nix
View File

@@ -48,9 +48,9 @@ in
settings = lib.mkOption {
default = defaultSettings;
defaultText = "See https://github.com/bitvora/haven/blob/master/.env.example";
defaultText = "See <https://github.com/bitvora/haven/blob/master/.env.example>";
apply = lib.recursiveUpdate defaultSettings;
description = "See https://github.com/bitvora/haven for documentation.";
description = "See <https://github.com/bitvora/haven> for documentation.";
example = lib.literalExpression ''
{
RELAY_URL = "relay.example.com";
@@ -63,7 +63,7 @@ in
type = lib.types.nullOr lib.types.path;
default = null;
description = ''
Path to a file containing sensitive environment variables. See https://github.com/bitvora/haven for documentation.
Path to a file containing sensitive environment variables. See <https://github.com/bitvora/haven> for documentation.
The file should contain environment-variable assignments like:
S3_SECRET_KEY=mysecretkey
S3_ACCESS_KEY_ID=myaccesskey

2
nixos/modules/services/web-apps/karakeep.nix
View File

@@ -34,7 +34,7 @@ in
Environment variables to pass to Karakaeep. This is how most settings
can be configured. Changing DATA_DIR is possible but not supported.
See https://docs.karakeep.app/configuration/
See <https://docs.karakeep.app/configuration/>
'';
type = lib.types.attrsOf lib.types.str;
default = { };

4
nixos/modules/services/web-apps/lasuite-docs.nix
View File

@@ -194,7 +194,7 @@ in
description = ''
Configuration options of collaboration server.
See https://github.com/suitenumerique/docs/blob/v${cfg.collaborationServer.package.version}/docs/env.md
See <https://github.com/suitenumerique/docs/blob/v${cfg.collaborationServer.package.version}/docs/env.md>
'';
};
};
@@ -327,7 +327,7 @@ in
description = ''
Configuration options of docs.
See https://github.com/suitenumerique/docs/blob/v${cfg.backendPackage.version}/docs/env.md
See <https://github.com/suitenumerique/docs/blob/v${cfg.backendPackage.version}/docs/env.md>
`REDIS_URL` and `CELERY_BROKER_URL` are set if `services.lasuite-docs.redis.createLocally` is true.
`DB_HOST` is set if `services.lasuite-docs.postgresql.createLocally` is true.

2
nixos/modules/services/web-apps/nextjs-ollama-llm-ui.nix
View File

@@ -37,7 +37,7 @@ in
Note: You should keep it at 127.0.0.1 and only serve to the local
network or internet from a (home) server behind a reverse-proxy and secured encryption.
See https://wiki.nixos.org/wiki/Nginx for instructions on how to set up a reverse-proxy.
See <https://wiki.nixos.org/wiki/Nginx> for instructions on how to set up a reverse-proxy.
'';
};

2
nixos/modules/services/web-apps/nostr-rs-relay.nix
View File

@@ -40,7 +40,7 @@ in
settings = lib.mkOption {
inherit (settingsFormat) type;
default = { };
description = "See https://git.sr.ht/~gheartsfield/nostr-rs-relay/#configuration for documentation.";
description = "See <https://git.sr.ht/~gheartsfield/nostr-rs-relay/#configuration> for documentation.";
};
};

4
nixos/modules/services/web-apps/outline.nix
View File

@@ -297,9 +297,9 @@ in
discordAuthentication = lib.mkOption {
description = ''
To configure Discord auth, you'll need to create an application at
https://discord.com/developers/applications/
<https://discord.com/developers/applications/>
See https://docs.getoutline.com/s/hosting/doc/discord-g4JdWFFub6
See <https://docs.getoutline.com/s/hosting/doc/discord-g4JdWFFub6>
for details on setting up your Discord app.
'';
default = null;

4
nixos/modules/services/web-apps/peertube-runner.nix
View File

@@ -53,7 +53,7 @@ in
description = ''
Configuration for peertube-runner.
See available configuration options at https://docs.joinpeertube.org/maintain/tools#configuration.
See available configuration options at <https://docs.joinpeertube.org/maintain/tools#configuration>.
'';
};
instancesToRegister = lib.mkOption {
@@ -72,7 +72,7 @@ in
description = ''
Path to a file containing a registration token for the PeerTube instance.
See how to generate registration tokens at https://docs.joinpeertube.org/admin/remote-runners#manage-remote-runners.
See how to generate registration tokens at <https://docs.joinpeertube.org/admin/remote-runners#manage-remote-runners>.
'';
};
runnerName = lib.mkOption {

2
nixos/modules/services/web-apps/pixelfed.nix
View File

@@ -173,7 +173,7 @@ in
default = "mysql";
description = ''
Database engine to use.
Note that PGSQL is not well supported: https://github.com/pixelfed/pixelfed/issues/2727
Note that PGSQL is not well supported: <https://github.com/pixelfed/pixelfed/issues/2727>
'';
};

2
nixos/modules/services/web-apps/porn-vault/default.nix
View File

@@ -55,7 +55,7 @@ in
description = ''
Configuration for Porn-Vault. The attributes are serialized to JSON in config.json.
See https://gitlab.com/porn-vault/porn-vault/-/blob/dev/config.example.json
See <https://gitlab.com/porn-vault/porn-vault/-/blob/dev/config.example.json>
'';
default = defaultConfig;
apply = lib.recursiveUpdate defaultConfig;

6
nixos/modules/services/web-apps/reposilite.nix
View File

@@ -116,7 +116,7 @@ let
type = lib.types.nullOr lib.types.str;
description = ''
Database connection string. Please use {option}`services.reposilite.database` instead.
See https://reposilite.com/guide/general#local-configuration for valid values.
See <https://reposilite.com/guide/general#local-configuration> for valid values.
'';
default = null;
};
@@ -141,7 +141,7 @@ let
Path to the .jsk KeyStore or paths to the PKCS#8 certificate and private key, separated by a space (see example).
You can use `''${WORKING_DIRECTORY}` to refer to paths relative to Reposilite's working directory.
If you are using a Java KeyStore, don't forget to specify the password via the {var}`REPOSILITE_LOCAL_KEYPASSWORD` environment variable.
See https://reposilite.com/guide/ssl for more information on how to set SSL up.
See <https://reposilite.com/guide/ssl> for more information on how to set SSL up.
'';
default = null;
example = "\${WORKING_DIRECTORY}/cert.pem \${WORKING_DIRECTORY}/key.pem";
@@ -354,7 +354,7 @@ in
assertion = cfg.settings.sslEnabled -> cfg.settings.keyPath != null;
message = ''
Reposilite was configured to enable SSL, but no valid paths to certificate files were provided via `settings.keyPath`.
Read more about SSL certificates here: https://reposilite.com/guide/ssl
Read more about SSL certificates here: <https://reposilite.com/guide/ssl>
'';
}
{

8
nixos/modules/services/web-apps/sharkey.nix
View File

@@ -33,7 +33,7 @@ in
List of paths to files containing environment variables for Sharkey to use at runtime.
This is useful for keeping secrets out of the Nix store. See
https://docs.joinsharkey.org/docs/install/configuration/ for how to configure Sharkey using environment
<https://docs.joinsharkey.org/docs/install/configuration/> for how to configure Sharkey using environment
variables.
'';
};
@@ -57,7 +57,7 @@ in
You need to ensure `services.meilisearch.masterKeyFile` is correctly configured for a working
Meilisearch setup. You also need to configure Sharkey to use an API key obtained from Meilisearch with the
`MK_CONFIG_MEILISEARCH_APIKEY` environment variable, and set `services.sharkey.settings.meilisearch.index` to
the created index. See https://docs.joinsharkey.org/docs/customisation/search/meilisearch/ for how to create
the created index. See <https://docs.joinsharkey.org/docs/customisation/search/meilisearch/> for how to create
an API key and index.
'';
};
@@ -141,7 +141,7 @@ in
Which provider to use for full text search.
All options other than `sqlLike` require extra setup - see the comments in
https://activitypub.software/TransFem-org/Sharkey/-/blob/develop/.config/example.yml for details.
<https://activitypub.software/TransFem-org/Sharkey/-/blob/develop/.config/example.yml> for details.
If `sqlPgroonga` is set, and `services.sharkey.setupPostgres` is `true`, the pgroonga extension will
automatically be setup. You still need to create an index manually.
@@ -172,7 +172,7 @@ in
description = ''
Configuration options for Sharkey.
See https://activitypub.software/TransFem-org/Sharkey/-/blob/develop/.config/example.yml for a list of all
See <https://activitypub.software/TransFem-org/Sharkey/-/blob/develop/.config/example.yml> for a list of all
available configuration options.
'';
};

4
nixos/modules/services/web-apps/stash.nix
View File

@@ -221,7 +221,7 @@ let
dangerous_allow_public_without_auth = mkOption {
type = types.bool;
default = false;
description = "Learn more at https://docs.stashapp.cc/networking/authentication-required-when-accessing-stash-from-the-internet/";
description = "Learn more at <https://docs.stashapp.cc/networking/authentication-required-when-accessing-stash-from-the-internet/>";
};
gallery_cover_regex = mkOption {
type = types.str;
@@ -276,7 +276,7 @@ let
security_tripwire_accessed_from_public_internet = mkOption {
type = types.nullOr types.str;
default = "";
description = "Learn more at https://docs.stashapp.cc/networking/authentication-required-when-accessing-stash-from-the-internet/";
description = "Learn more at <https://docs.stashapp.cc/networking/authentication-required-when-accessing-stash-from-the-internet/>";
};
sequential_scanning = mkOption {
type = types.bool;

2
nixos/modules/services/web-apps/strfry.nix
View File

@@ -92,7 +92,7 @@ in
type = settingsFormat.type;
default = defaultSettings;
apply = lib.recursiveUpdate defaultSettings;
description = "Configuration options to set for the Strfry service. See https://github.com/hoytech/strfry for documentation.";
description = "Configuration options to set for the Strfry service. See <https://github.com/hoytech/strfry> for documentation.";
example = lib.literalExpression ''
dbParams = {
maxreaders = 256;

2
nixos/modules/services/web-apps/youtrack.md
View File

@@ -15,7 +15,7 @@ You can find this token in the log of the `youtrack` service. The log line looks
Starting with YouTrack 2023.1, JetBrains no longer distributes it as as JAR.
The new distribution with the JetBrains Launcher as a ZIP changed the basic data structure and also some configuration parameters.
Check out https://www.jetbrains.com/help/youtrack/server/YouTrack-Java-Start-Parameters.html for more information on the new configuration options.
Check out <https://www.jetbrains.com/help/youtrack/server/YouTrack-Java-Start-Parameters.html> for more information on the new configuration options.
When upgrading to YouTrack 2023.1 or higher, a migration script will move the old state directory to `/var/lib/youtrack/2022_3` as a backup.
A one-time manual update is required: