alexion/dev
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(copyparty): clarify option descriptions

Browse Source
This commit is contained in:
alexion
2026-10-12 22:36:04 -04:00
parent f8c08abda8
commit 372c19387a
2 changed files with 24 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
configs/nixos/modules/services/copyparty/default.nix
View File

@@ -14,36 +14,36 @@ in
port = lib.mkOption {
type = lib.types.port;
default = 3923;
description = "Port Copyparty listens on.";
description = "Sets the TCP port that Copyparty listens on.";
};
user = lib.mkOption {
type = lib.types.str;
default = "copyparty";
description = "User account that runs Copyparty.";
description = "Sets the user that runs Copyparty.";
};
group = lib.mkOption {
type = lib.types.str;
default = "storage";
description = "Group account that owns Copyparty's writable state and served files.";
description = "Sets the group that owns Copyparty state and served files.";
};
accountName = lib.mkOption {
type = lib.types.str;
default = "alexion";
description = "Copyparty account name configured for password authentication.";
description = "Sets the Copyparty account name for password authentication.";
};
passwordFile = lib.mkOption {
type = lib.types.str;
description = "Runtime file containing the Copyparty account password.";
description = "Sets the runtime file that contains the Copyparty account password.";
};
stateDir = lib.mkOption {
type = lib.types.str;
default = "/var/lib/copyparty";
description = "Directory where Copyparty stores service state.";
description = "Sets the directory where Copyparty stores service state.";
};
volumes = lib.mkOption {
@@ -52,7 +52,7 @@ in
options = {
path = lib.mkOption {
type = lib.types.externalPath;
description = "Filesystem path served by this volume.";
description = "Sets the filesystem path served by this volume.";
};
access = lib.mkOption {
@@ -61,13 +61,13 @@ in
example = {
A = [ "alexion" ];
};
description = "Copyparty access map from permission string to account names.";
description = "Maps Copyparty permission strings to account names.";
};
readOnly = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Serve this volume read-only.";
description = "Serves this volume read-only.";
};
flags = lib.mkOption {
@@ -76,13 +76,13 @@ in
example = {
dthumb = true;
};
description = "Copyparty volume flags.";
description = "Sets Copyparty volume flags.";
};
};
}
);
default = { };
description = "Copyparty volumes keyed by their URL path.";
description = "Defines Copyparty volumes by URL path.";
};
reverseProxy = {
@@ -91,7 +91,7 @@ in
trustedSources = lib.mkOption {
type = lib.types.listOf lib.types.str;
default = [ ];
description = "IP ranges that may supply Copyparty's forwarded client IP header.";
description = "Lists proxy sources that can set Copyparty's forwarded client IP header.";
};
};
};

24
configs/nixos/modules/services/copyparty/nixos-module.nix
View File

@@ -89,31 +89,31 @@ in
user = lib.mkOption {
type = lib.types.str;
default = "copyparty";
description = "User account that runs Copyparty.";
description = "Sets the user that runs Copyparty.";
};
group = lib.mkOption {
type = lib.types.str;
default = "copyparty";
description = "Group account that runs Copyparty.";
description = "Sets the group that runs Copyparty.";
};
stateDir = lib.mkOption {
type = lib.types.str;
default = "/var/lib/copyparty";
description = "Directory where Copyparty stores service state.";
description = "Sets the directory where Copyparty stores service state.";
};
settings = lib.mkOption {
type = lib.types.attrs;
default = { };
description = "Copyparty global settings rendered in the [global] config section.";
description = "Defines Copyparty settings for the `[global]` config section.";
};
globalExtraConfig = lib.mkOption {
type = lib.types.lines;
default = "";
description = "Extra Copyparty global config lines appended after rendered global settings.";
description = "Appends extra lines after rendered global settings.";
};
accounts = lib.mkOption {
@@ -121,12 +121,12 @@ in
lib.types.submodule {
options.passwordFile = lib.mkOption {
type = lib.types.str;
description = "Runtime file containing this Copyparty account's password.";
description = "Sets the runtime file that contains this account's password.";
};
}
);
default = { };
description = "Copyparty accounts keyed by account name.";
description = "Defines Copyparty accounts by account name.";
};
volumes = lib.mkOption {
@@ -135,31 +135,31 @@ in
options = {
path = lib.mkOption {
type = lib.types.externalPath;
description = "Filesystem path served by this volume.";
description = "Sets the filesystem path served by this volume.";
};
access = lib.mkOption {
type = lib.types.attrsOf (lib.types.listOf lib.types.str);
default = { };
description = "Copyparty access map from permission string to account names.";
description = "Maps Copyparty permission strings to account names.";
};
readOnly = lib.mkOption {
type = lib.types.bool;
default = false;
description = "Bind this volume read-only into the Copyparty systemd service.";
description = "Binds this volume read-only into the Copyparty systemd service.";
};
flags = lib.mkOption {
type = lib.types.attrs;
default = { };
description = "Copyparty volume flags.";
description = "Sets Copyparty volume flags.";
};
};
}
);
default = { };
description = "Copyparty volumes keyed by their URL path.";
description = "Defines Copyparty volumes by URL path.";
};
};