mirrors/copyparty
1
0
Fork 0
mirror of https://github.com/9001/copyparty.git synced 2026-01-12 15:52:39 -07:00
Code Issues Actions Packages Projects Releases Wiki Activity

NixOS: misc module documentation improvements (#1194)

Browse source 
* nixos: use mkPackageOption instead of mkOption for the package option

This gets rid of a warning when trying to build a system with
documentation.nixos.includeAllModules enabled

* nixos: don't include package path in option descriptions

See https://github.com/9001/copyparty/pull/1193, this actually fixes the issue

* nixos: fix formatting of services.copyparty.volumes.<name>.access

List will now show up properly on the nixos manual!

* nixos: add or improve inline code blocks in option descriptions
This commit is contained in:
Toast 2026-01-12 16:43:18 +01:00 committed by GitHub
parent 9d223d6ca7
commit d5a8a34bca
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
contrib/nixos/modules/copyparty.nix
View file

@ -79,7 +79,7 @@ in
type = types.bool; type = types.bool;
default = true; default = true;
description = '' description = ''
Make a shell script wrapper called 'copyparty-hash' with all options set here, Make a shell script wrapper called {command}`copyparty-hash` with all options set here,
that launches the hashing cli. that launches the hashing cli.
''; '';
}; };
@ -114,9 +114,9 @@ in
type = types.attrs; type = types.attrs;
description = '' description = ''
Global settings to apply. Global settings to apply.
Directly maps to values in the [global] section of the copyparty config. Directly maps to values in the `[global]` section of the copyparty config.
Cannot set "c" or "hist", those are set by this module. Cannot set "c" or "hist", those are set by this module.
See `${getExe cfg.package} --help` for more details. See {command}`copyparty --help` for more details.
''; '';
default = { default = {
i = "127.0.0.1"; i = "127.0.0.1";
@ -135,7 +135,7 @@ in
globalExtraConfig = mkOption { globalExtraConfig = mkOption {
type = types.str; type = types.str;
default = ""; default = "";
description = "Appended to the end of the [global] section verbatim. This is useful for flags which are used in a repeating manner (e.g. ipu: 255.255.255.1=user) which can't be repeated in the settings = {} attribute set."; description = "Appended to the end of the `[global]` section verbatim. This is useful for flags which are used in a repeating manner (e.g. `ipu: 255.255.255.1=user`) which can't be repeated in the settings = {} attribute set.";
}; };
accounts = mkOption { accounts = mkOption {
@ -198,21 +198,21 @@ in
Attribute list of permissions and the users to apply them to. Attribute list of permissions and the users to apply them to.
The key must be a string containing any combination of allowed permission: The key must be a string containing any combination of allowed permission:
"r" (read): list folder contents, download files * "r" (read): list folder contents, download files
"w" (write): upload files; need "r" to see the uploads * "w" (write): upload files; need "r" to see the uploads
"m" (move): move files and folders; need "w" at destination * "m" (move): move files and folders; need "w" at destination
"d" (delete): permanently delete files and folders * "d" (delete): permanently delete files and folders
"g" (get): download files, but cannot see folder contents * "g" (get): download files, but cannot see folder contents
"G" (upget): "get", but can see filekeys of their own uploads * "G" (upget): "get", but can see filekeys of their own uploads
"h" (html): "get", but folders return their index.html * "h" (html): "get", but folders return their index.html
"a" (admin): can see uploader IPs, config-reload * "a" (admin): can see uploader IPs, config-reload
For example: "rwmd" For example: "rwmd"
The value must be one of: The value must be one of:
an account name, defined in `accounts` * an account name, defined in `accounts`
a list of account names * a list of account names
"*", which means "any account" * "*", which means "any account"
''; '';
example = literalExpression '' example = literalExpression ''
{ {
@ -227,7 +227,7 @@ in
type = types.attrs; type = types.attrs;
description = '' description = ''
Attribute list of volume flags to apply. Attribute list of volume flags to apply.
See `${getExe cfg.package} --help-flags` for more details. See {command}`copyparty --help-flags` for more details.
''; '';
example = literalExpression '' example = literalExpression ''
{ {