Unverified Commit f5f87e72 authored by Austin Horstman's avatar Austin Horstman Committed by GitHub
Browse files

dashy-ui: init at 3.1.1-unstable-2024-07-14 (#349149)

parents 608a4a6e 7f76ced7
Loading
Loading
Loading
Loading
+6 −0
Original line number Diff line number Diff line
@@ -21772,6 +21772,12 @@
    githubId = 57180880;
    name = "Ansh Tyagi";
  };
  therealgramdalf = {
    email = "gramdalftech@gmail.com";
    github = "TheRealGramdalf";
    githubId = 79593869;
    name = "Gramdalf";
  };
  therealr5 = {
    email = "rouven@rfive.de";
    github = "therealr5";
+2 −0
Original line number Diff line number Diff line
@@ -109,6 +109,8 @@

- [Firefly-iii Data Importer](https://github.com/firefly-iii/data-importer), a data importer for Firefly-III. Available as [services.firefly-iii-data-importer](options.html#opt-services.firefly-iii-data-importer.enable).

- [Dashy](https://dashy.to), an open source, highly customizable, easy to use, privacy-respecting dashboard app. Available as [services.dashy](options.html#opt-services.dashy).

- [QGroundControl], a ground station support and configuration manager for the PX4 and APM Flight Stacks. Available as [programs.qgroundcontrol](options.html#opt-programs.qgroundcontrol.enable).

- [Eintopf](https://eintopf.info), a community event and calendar web application. Available as [services.eintopf](options.html#opt-services.eintopf.enable).
+173 −0
Original line number Diff line number Diff line
{
  config,
  lib,
  pkgs,
  ...
}:
let
  inherit (lib.types) package str;
  inherit (lib)
    mkIf
    mkOption
    mkEnableOption
    mkPackageOption
    ;
  cfg = config.services.dashy;
in
{
  options.services.dashy = {
    enable = mkEnableOption ''
      Dashy, a highly customizable, easy to use, privacy-respecting dashboard app.

      Note that this builds a static web app as opposed to running a full node server, unlike the default docker image.

      Writing config changes to disk through the UI, triggering a rebuild through the UI and application status checks are
      unavailable without the node server; Everything else will work fine.

      See the deployment docs for [building from source](https://dashy.to/docs/deployment#build-from-source), [hosting with a CDN](https://dashy.to/docs/deployment#hosting-with-cdn) and [CDN cloud deploy](https://dashy.to/docs/deployment#cdn--cloud-deploy) for more information.
    '';

    virtualHost = {
      enableNginx = mkEnableOption "a virtualhost to serve dashy through nginx";

      domain = mkOption {
        description = ''
          Domain to use for the virtual host.

          This can be used to change nginx options like
          ```nix
          services.nginx.virtualHosts."$\{config.services.dashy.virtualHost.domain}".listen = [ ... ]
          ```
          or
          ```nix
          services.nginx.virtualHosts."example.com".listen = [ ... ]
          ```
        '';
        type = str;
      };
    };

    package = mkPackageOption pkgs "dashy-ui" { };

    finalDrv = mkOption {
      readOnly = true;
      default =
        if cfg.settings != { } then cfg.package.override { inherit (cfg) settings; } else cfg.package;
      defaultText = ''
        if cfg.settings != {}
        then cfg.package.override {inherit (cfg) settings;}
        else cfg.package;
      '';
      type = package;
      description = ''
        Final derivation containing the fully built static files
      '';
    };

    settings = mkOption {
      default = { };
      description = ''
        Settings serialized into `user-data/conf.yml` before build.
        If left empty, the default configuration shipped with the package will be used instead.

        Note that the full configuration will be written to the nix store as world readable, which may include secrets such as [password hashes](https://dashy.to/docs/configuring#appconfigauthusers-optional).

        To add files such as icons or backgrounds, you can reference them in line such as
        ```nix
        icon = "$\{./icon.png}";
        ```
        This will add the file to the nix store upon build, referencing it by file path as expected by Dashy.
      '';
      example = ''
        {
          appConfig = {
            cssThemes = [
              "example-theme-1"
              "example-theme-2"
            ];
            enableFontAwesome = true;
            fontAwesomeKey = "e9076c7025";
            theme = "thebe";
          };
          pageInfo = {
            description = "My Awesome Dashboard";
            navLinks = [
              {
                path = "/";
                title = "Home";
              }
              {
                path = "https://example.com";
                title = "Example 1";
              }
              {
                path = "https://example.com";
                title = "Example 2";
              }
            ];
            title = "Dashy";
          };
          sections = [
            {
              displayData = {
                collapsed = true;
                cols = 2;
                customStyles = "border: 2px dashed red;";
                itemSize = "large";
              };
              items = [
                {
                  backgroundColor = "#0079ff";
                  color = "#00ffc9";
                  description = "Source code and documentation on GitHub";
                  icon = "fab fa-github";
                  target = "sametab";
                  title = "Source";
                  url = "https://github.com/Lissy93/dashy";
                }
                {
                  description = "View currently open issues, or raise a new one";
                  icon = "fas fa-bug";
                  title = "Issues";
                  url = "https://github.com/Lissy93/dashy/issues";
                }
                {
                  description = "Live Demo #1";
                  icon = "fas fa-rocket";
                  target = "iframe";
                  title = "Demo 1";
                  url = "https://dashy-demo-1.as93.net";
                }
                {
                  description = "Live Demo #2";
                  icon = "favicon";
                  target = "newtab";
                  title = "Demo 2";
                  url = "https://dashy-demo-2.as93.net";
                }
              ];
              name = "Getting Started";
            }
          ];
        }
      '';
      inherit (pkgs.formats.json { }) type;
    };
  };

  config = mkIf cfg.enable {
    services.nginx = mkIf cfg.virtualHost.enableNginx {
      enable = true;
      virtualHosts."${cfg.virtualHost.domain}" = {
        locations."/" = {
          root = cfg.finalDrv;
          tryFiles = "$uri /index.html ";
        };
      };
    };
  };

  meta.maintainers = [
    lib.maintainers.therealgramdalf
  ];
}
+57 −0
Original line number Diff line number Diff line
{
  lib,
  stdenv,
  fetchFromGitHub,
  fetchYarnDeps,
  yarnConfigHook,
  yarnBuildHook,
  nodejs,
  yq-go,
  settings ? { },
}:
stdenv.mkDerivation (finalAttrs: {
  pname = "dashy-ui";
  # This is like 3.1.1 but the latest working yarn.lock.
  # All other changes are for docs with the exception of 768d746cbfcf365c58ad1194c5ccc74c14f3ed3a, which simply adds no-referrer meta tag
  version = "3.1.1-unstable-2024-07-14";
  src = fetchFromGitHub {
    owner = "lissy93";
    repo = "dashy";
    rev = "0b1af9db483f80323e782e7834da2a337393e111";
    hash = "sha256-lRJ3lI9UUIaw9GWPEy81Dbf4cu6rClA4VjdWejVQN+g=";
  };
  yarnOfflineCache = fetchYarnDeps {
    yarnLock = finalAttrs.src + "/yarn.lock";
    hash = "sha256-KVAZIBM47yp1NWYc2esvTwfoAev4q7Wgi0c73PUZRNw=";
  };
  # - If no settings are passed, use the default config provided by upstream
  # - Despite JSON being valid YAML (and the JSON passing the config validator),
  # there seem to be some issues with JSON in the final build - potentially due to
  # the way the client parses things
  # - Instead, we use `yq-go` to convert it to yaml
  # Config validation needs to happen after yarnConfigHook, since it's what sets the yarn offline cache
  postYarnConfigHook = lib.optional (settings != { }) ''
    echo "Writing settings override..."
    yq --output-format yml '${builtins.toFile "conf.json" ''${builtins.toJSON settings}''}' > user-data/conf.yml
    yarn validate-config --offline
  '';
  installPhase = ''
    mkdir $out
    cp -R dist/* $out
  '';

  nativeBuildInputs = [
    yarnConfigHook
    yarnBuildHook
    nodejs
    # For yaml parsing
    yq-go
  ];
  doDist = false;
  meta = {
    description = "dashy";
    homepage = "https://dashy.to";
    license = lib.licenses.mit;
    maintainers = [ lib.maintainers.therealgramdalf ];
  };
})