osticket: add module #148959

wmertens · 2021-12-06T10:07:49Z

Motivation for this change

Add osTicket, a nice support ticketing system with email support, as a module.

Things done

Built on platform(s)
- x86_64-linux
Tested, as applicable:
- NixOS test(s) (look inside nixos/tests)
- and/or package tests
- or, for functions and "core" functionality, tests in lib/tests or pkgs/test
- made sure NixOS tests are linked to the relevant packages
Tested basic functionality of all binary files (usually in ./result/bin/)
22.05 Release Notes (or backporting 21.11 Release notes)
- (Module addition) Added a release notes entry if adding a new NixOS module
- (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
Fits CONTRIBUTING.md.

To Do

move derivation into separate package
make OST_CONFIG, like in the mediawiki package
do not make cron.php executable
override favicon via nginx
pick plugins via derivation pkgs.osticket.withPackages (p: with p; [ slack ])

wmertens · 2021-12-06T10:49:16Z

not sure how to fix the manual build :-(

nixos/modules/services/misc/osticket/default.nix

i077 · 2021-12-07T14:52:48Z

nixos/modules/services/misc/osticket/default.nix

+        echo ${version}
+      '';
+
+      pkg = pkgs.stdenv.mkDerivation rec {


Is there a reason you're not adding this derivation to the package set and instead putting it directly in the module?

the derivation needs the database user etc. Without it, it won't work, and it doesn't make much sense as a stand-alone package.

That's why I thought it would be better together in the module.

I saw the same for mediawiki

In fact mediawiki does have a package. What you linked to was a bit of a wrapper around the package. You should definitely create a separate derivation file in the pkgs/ tree... how else will our bots automatically update your software?

aanderse

I left some comments... More than I intended to, I guess. I hope they are of value to you. If you need a hand with anything feel free to ping.

aanderse · 2021-12-08T12:44:32Z

nixos/modules/services/misc/osticket/default.nix

+          # Patch the location of the config file and the version
+          sed -i -e "s|INCLUDE_DIR.'ost-config.php'|'${stateDir}/ost-config.php'|" -e "s|define('GIT_VERSION', '\\$git')|define('GIT_VERSION', '${version}')|" bootstrap.php
+          sed -i "s|../include|${stateDir}|" setup/install.php


A nicer approach here is to leave the application looking at include/ost-config.php, but then create your own version of the file that consists of this:

<?php return require(getenv('OST_CONFIG')); ?>

Take a look at the mediawiki package.

aanderse · 2021-12-08T12:46:43Z

nixos/modules/services/misc/osticket/default.nix

+          # Pre-populate the database settings for setup.
+          # The password is not used but required.
+          sed -i "s|'dbhost'=>'localhost'|'dbhost'=>'localhost','dbuser'=>'${user}','dbpass'=>'${user}','dbname'=>'${user}'|" setup/inc/install.inc.php


Does this imply that the user has to click through a web form to complete installation of this software?

Yes indeed, there are a bunch of settings to configure and I think automating that ok to keep out of scope for an initial module?

aanderse · 2021-12-08T12:49:03Z

nixos/modules/services/misc/osticket/default.nix

+          # Add script header for cron
+          sed -i '1i\#!/usr/bin/env php' api/cron.php


Upstream doesn't intend for this script to be executable. See below suggestion in definition of systemd.services."${user}-cron".

nixos/modules/services/misc/osticket/default.nix

aanderse · 2021-12-08T12:52:50Z

nixos/modules/services/misc/osticket/default.nix

+          {
+            root = mkForce "${pkg}/public";
+
+            locations = {


Do you have a link to the documentation on how you got all these locations?

alas no, they were extracted by eyeball from the apache configuration files

aanderse · 2021-12-08T12:58:52Z

nixos/modules/services/misc/osticket/default.nix

+          chmod a+x $out/public/manage.php $out/public/api/cron.php $out/public/api/pipe.php
+          mkdir -p $out/bin
+          ln -s ../public/manage.php $out/bin/osticket_manage
+          ln -s ../public/api/cron.php $out/bin/osticket_cron


No longer required if you accept my suggestion about the cron job.

aanderse · 2021-12-08T12:59:14Z

nixos/modules/services/misc/osticket/default.nix

+          description = "Issue tracking system";
+          platforms = platforms.linux;
+          maintainers = [ maintainers.wmertens ];
+          license = licenses.gpl2;


gpl2Only or gpl2Plus?

Looks to be gpl2Only? https://github.com/osTicket/osTicket/blob/develop/LICENSE.txt

aanderse · 2021-12-08T13:00:51Z

nixos/modules/services/misc/osticket/default.nix

+            # TODO extensions function on plugin definition
+            #   that then gets mapped and joined


nixos/modules/services/misc/osticket/default.nix

aanderse · 2021-12-08T13:04:11Z

nixos/modules/services/misc/osticket/default.nix

+      };
+
+      # TODO make this nicer wrt getting the plugins, perhaps ship all plugins by default + allow extra
+      plugins = mkOption {


It is possible this would be better as an argument to the derivation (when you move that to a separate file) than an option to the module... 🤔 Maybe pkgs.osticket.withPackages (p: with p; [ slack ])? 😅

Co-authored-by: Aaron Andersen <aaron@fosslib.net>

wmertens · 2022-05-06T12:38:52Z

@aanderse thank you for your thorough review and hints, I distilled them into todos and will address them... this year? 😅

RaitoBezarius · 2022-12-22T02:44:34Z

The year is soon ending! Can I help you to get this merged? It can be merged the next year if needed :P.

github-actions bot added 6.topic: nixos 8.has: changelog 8.has: documentation 8.has: module (update) labels Dec 6, 2021

wmertens force-pushed the osticket branch from 4dc1e34 to 0445bb1 Compare December 6, 2021 10:53

pennae reviewed Dec 6, 2021

View reviewed changes

nixos/modules/services/misc/osticket/default.nix Outdated Show resolved Hide resolved

aanderse self-requested a review December 6, 2021 16:59

wmertens force-pushed the osticket branch 2 times, most recently from 6869775 to af7b955 Compare December 6, 2021 20:44

osticket: add module

b99852f

wmertens force-pushed the osticket branch from af7b955 to b99852f Compare December 6, 2021 21:31

ofborg bot added 10.rebuild-darwin: 0 10.rebuild-linux: 1-10 labels Dec 6, 2021

i077 reviewed Dec 7, 2021

View reviewed changes

aanderse reviewed Dec 8, 2021

View reviewed changes

wmertens and others added 2 commits May 6, 2022 14:32

Update nixos/modules/services/misc/osticket/default.nix

770ab17

Co-authored-by: Aaron Andersen <aaron@fosslib.net>

Update nixos/modules/services/misc/osticket/default.nix

41de34e

Co-authored-by: Aaron Andersen <aaron@fosslib.net>

ofborg bot added the 2.status: merge conflict label May 6, 2022

stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Nov 12, 2022

stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Dec 22, 2022

wegank added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Mar 19, 2024

wegank marked this pull request as draft March 20, 2024 15:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

osticket: add module #148959

osticket: add module #148959

wmertens commented Dec 6, 2021 •

edited

wmertens commented Dec 6, 2021

i077 Dec 7, 2021

wmertens Dec 7, 2021 •

edited

aanderse Dec 8, 2021

aanderse left a comment

aanderse Dec 8, 2021

aanderse Dec 8, 2021

wmertens May 6, 2022

aanderse Dec 8, 2021

aanderse Dec 8, 2021

wmertens May 6, 2022

aanderse Dec 8, 2021

aanderse Dec 8, 2021

wmertens May 6, 2022

aanderse Dec 8, 2021

aanderse Dec 8, 2021

wmertens commented May 6, 2022

RaitoBezarius commented Dec 22, 2022

		# Add script header for cron
		sed -i '1i\#!/usr/bin/env php' api/cron.php

		# TODO extensions function on plugin definition
		# that then gets mapped and joined

osticket: add module #148959

Are you sure you want to change the base?

osticket: add module #148959

Conversation

wmertens commented Dec 6, 2021 • edited

Motivation for this change

Things done

To Do

wmertens commented Dec 6, 2021

Choose a reason for hiding this comment

wmertens Dec 7, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

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

wmertens commented May 6, 2022

RaitoBezarius commented Dec 22, 2022

wmertens commented Dec 6, 2021 •

edited

wmertens Dec 7, 2021 •

edited