Skip to content

Commit

Permalink
Document finder module and options
Browse files Browse the repository at this point in the history
  • Loading branch information
barrucadu committed Oct 15, 2023
1 parent 98c5296 commit 4325768
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 5 deletions.
8 changes: 8 additions & 0 deletions shared/finder/default.nix
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Webapp to read downloaded manga. There is no public deployment.
#
# finder uses a containerised elasticsearch database, and requires read access
# to the filesystem where manga is stored. It does not manage the manga, only
# provides an interface to search and read.
#
# The database can be recreated from the manga files, so this module does not
# include a backup script.
{ config, lib, ... }:

with lib;
Expand Down
43 changes: 38 additions & 5 deletions shared/finder/options.nix
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,43 @@ with lib;

{
options.nixfiles.finder = {
enable = mkOption { type = types.bool; default = false; };
image = mkOption { type = types.str; };
port = mkOption { type = types.int; default = 44986; };
esTag = mkOption { type = types.str; default = "8.0.0"; };
mangaDir = mkOption { type = types.path; };
enable = mkOption {
type = types.bool;
default = false;
description = mdDoc ''
Enable the `finder` module.
'';
};

image = mkOption {
type = types.str;
description = mdDoc ''
Container image to use.
'';
};

port = mkOption {
type = types.int;
default = 44986;
description = mdDoc ''
Port (on 127.0.0.1) to expose the finder service on.
'';
};

esTag = mkOption {
type = types.str;
default = "8.0.0";
description = mdDoc ''
Tag to use of the `elasticsearch` container image.
'';
};

mangaDir = mkOption {
type = types.path;
example = "/mnt/nas/manga";
description = mdDoc ''
Directory to serve manga files from.
'';
};
};
}

0 comments on commit 4325768

Please sign in to comment.