Add lotide, hitide and service definitions for both #107505

matthiasbeyer · 2020-12-23T23:52:26Z

Add lotide, hitide and service definitions for both.

As I do not often write service definitions, please someone have a look at those.
I did not yet test them. I don't know how, tbh. Maybe by rebasing these patches to nixos-stable and then building my system from it? Isn't there a smoother way for that?

Things done

aanderse

Thanks for the contribution. I have left some comments I hope that you will find helpful. If you need any clarification, etc... please don't hesitate to ask.

There are a few options to test this. You could use build-vm, include these modules into your current system using overlays and imports, build your system against this branch, etc... In addition to any of these ways a NixOS test would be greatly appreciated. See the nixos/tests folder for examples of NixOS tests. These tests give committers unfamiliar with the software greater confidence in merging updates to your packages in the future.

aanderse · 2020-12-24T13:58:54Z

nixos/modules/services/web-apps/hitide.nix

+    backendHost = mkOption {
+      default = null;
+      type = types.string;
+      description = "URL path to lotide";


Please consistently use a trailing period for all descriptions, except for those with mkEnableOption.

aanderse · 2020-12-24T13:59:11Z

nixos/modules/services/web-apps/hitide.nix

+
+    port = mkOption {
+      default = 4333;
+      type = types.int;


types.port please.

aanderse · 2020-12-24T14:00:50Z

nixos/modules/services/web-apps/hitide.nix

+        Environment = [
+          "BACKEND_HOST=${cfg.backendHost}"
+          "PORT=${cfg.port}"
+        ];


I prefer to use systemd.services.<name>.environment here instead, like so:

systemd.services.hitide = { environment = { BACKEND_HOST = cfg.backendHost; PORT = cfg.port; }; };

aanderse · 2020-12-24T14:01:53Z

nixos/modules/services/web-apps/hitide.nix

+  options.services.hitide = {
+    enable = mkEnableOption "the hitide service";
+
+    package = mkOption {


There is only one version of hitide available, and there are no variants on it. This option provides no value, in my opinion.

I disagree... I started contributing to lotide/hitide development and would like to run development versions of it on my server, where I overwrite the package to build from different sources. This option gives me the abiltity to easily deploy different versions.
I would like to keep it therefore.

Sure, it is fine to keep... but it sounds like what you really want is an overlay 🤔

After some more thinking, I guess you're right here.

aanderse · 2020-12-24T14:05:26Z

nixos/modules/services/web-apps/hitide.nix

+  };
+
+  config = mkIf cfg.enable {
+    systemd.services.hitide = {


Would you consider submitting a change upstream to include a systemd unit in their repo? If so, we could eventually (mostly) drop the unit from nixpkgs an utilize systemd.packages = [ pkgs.hitide ];. If you're up for that full bonus points will be awarded 🎉

Not sure whether they would accept such patches upstream, but I will see what I can do and then report back here.

Fantastic! Thanks.

aanderse · 2020-12-24T14:21:01Z

nixos/modules/services/web-apps/lotide.nix

+  };
+
+  config = mkIf cfg.enable {
+    systemd.services.lotide = {


Would you consider submitting a change upstream to include a systemd unit in their repo? If so, we could eventually (mostly) drop the unit from nixpkgs an utilize systemd.packages = [ pkgs.lotide ];. If you're up for that full bonus points will be awarded 🎉

Can you give some more detail on that? Does that mean that the lotide.service or hitide.service file from upstream can be included here? How can I point to the actual path in the upstream repository? How can I make them configurable from nix?

Sure. If pkgs.lotide any .service files under $out/lib/systemd/system and you specify systemd.packages = [ pkgs.lotide ]; then these systemd unit files will be included in your system when built.

Checkout this commit where I made use of the upstream systemd unit, but then provided a few changes on top of the upstream unit specifically for NixOS.

So the package needs to install them properly, okay.
And there's no way for a user of the service definition to overwrite values in the definition?

I don't think so.

Hm. After some more thinking about the whole thing, I guess it is not a good idea to include a .service file from upstream - because lotide/hitide is configured via environment variables... A user actually wants to overwrite the environment of the services. Having a .service file prevents that (from my understanding).

Both NixOS and systemd excel here. Both allow extensive overriding to handle situations like this, both from the perspective of the distro and the perspective of the sysadmin.

Here is a reasonable starting point to learn about this: https://serverfault.com/questions/413397/how-to-set-environment-variable-in-systemd-service

Let me know if you have any questions.

nixos/modules/services/web-apps/hitide.nix

nixos/modules/services/web-apps/lotide.nix

nixos/modules/services/web-apps/hitide.nix

matthiasbeyer · 2020-12-25T09:46:55Z

Thanks for your suggestions, I will resolve them in the coming days.

BTW: What did the github engineers think when they built the "Commit suggestion" feature? Why doesn't this create !fixup commits by default? This feature is complete bullshit if it does not create fixup commits...
(not your fault of course, I just wanted to say this loud)

matthiasbeyer · 2020-12-28T21:59:35Z

Okay, so I just pushed some fixups (for example I used the deprecated types.string, which was replaced with types.str now).
Unfortunately, I fail to build a testing VM with lotide and hitide:

I tried to use nixos-shell with:

{ config, pkgs, ... }:
{
  boot.kernelPackages = pkgs.linuxPackages_latest;

  services.lotide = {
    enable = true;
    databaseUrl = "postgresql://user@passwort@localhost:5432/lotidedb";
    hostUrlActivityPub = "https://lotide.example.com";
    hostUrlAPI = "https://lotide.example.com/api";
    apubProxyRewrites = true;
    allowForwarded = true;
  };

  services.hitide = {
    enable = true;
    backendHost = "localhost"; # default
      port = 4333; # default
  };

  services.nginx = {
    enable = true;
    virtualHosts = {
      "lotide.example.com" = {
        locations."/".proxyPass = "http://localhost:${builtins.toString config.services.hitide.port}";
      };
    };
  };

  services.postgresql = {
    enable = true;
    package = pkgs.postgresql_12;
    dataDir = "/var/db-lotide";

    initialScript = pkgs.writeText "psql-init" ''
      CREATE USER user PASSWORD 'password' LOGIN;
    CREATE DATABASE lotidedb WITH OWNER user;
    '';
  };
}

Edit: It errors with "expected set, got list" or something like that. But I do not know why.

aanderse · 2021-01-03T14:48:29Z

@matthiasbeyer apply this to fix: a5c9b67

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

ofborg bot added 6.topic: nixos 8.has: module (update) labels Dec 23, 2020

aanderse requested changes Dec 24, 2020

View reviewed changes

ofborg bot added 8.has: package (new) 11.by: package-maintainer 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Dec 28, 2020

matthiasbeyer and others added 5 commits February 1, 2021 15:23

hitide: init at 0.8.0

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.

GPG key ID: 4AEE18F83AFDEB23
Expired

Verified
Learn about vigilant mode

7e0f835

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

lotide: init at 0.8.0

adfb555

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

Add service definition: lotide

328d1b0

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

Add service definition: hitide

4b6a6c8

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

nixos/lotide: minor fixups

8533f37

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>

matthiasbeyer force-pushed the init-lohitide branch from 0be90b2 to 8533f37 Compare February 1, 2021 14:34

matthiasbeyer closed this Apr 13, 2021

matthiasbeyer deleted the init-lohitide branch April 13, 2021 11:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add lotide, hitide and service definitions for both #107505

Add lotide, hitide and service definitions for both #107505

matthiasbeyer commented Dec 23, 2020

aanderse left a comment

aanderse Dec 24, 2020

aanderse Dec 24, 2020

aanderse Dec 24, 2020

aanderse Dec 24, 2020

matthiasbeyer Dec 25, 2020

aanderse Dec 25, 2020

matthiasbeyer Dec 26, 2020

aanderse Dec 24, 2020

matthiasbeyer Dec 25, 2020

aanderse Dec 25, 2020

aanderse Dec 24, 2020

matthiasbeyer Dec 26, 2020

aanderse Dec 27, 2020

matthiasbeyer Dec 27, 2020

aanderse Dec 27, 2020

matthiasbeyer Dec 28, 2020

aanderse Dec 28, 2020

matthiasbeyer commented Dec 25, 2020

matthiasbeyer commented Dec 28, 2020 •

edited

Loading

aanderse commented Jan 3, 2021

Add lotide, hitide and service definitions for both #107505

Add lotide, hitide and service definitions for both #107505

Conversation

matthiasbeyer commented Dec 23, 2020

Things done

aanderse left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

matthiasbeyer commented Dec 25, 2020

matthiasbeyer commented Dec 28, 2020 • edited Loading

aanderse commented Jan 3, 2021

matthiasbeyer commented Dec 28, 2020 •

edited

Loading