Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

discourse: init at 2.4.1 #83438

Draft
wants to merge 6 commits into
base: master
from
Draft

discourse: init at 2.4.1 #83438

wants to merge 6 commits into from

Conversation

@sorki
Copy link
Member

@sorki sorki commented Mar 26, 2020

Motivation for this change

Discourse NixOS support.

Things done

Packaged two main components - rails application and mail forwarding utility.
Rail application has one major problem - it cannot compile javascript assets - assets:recompile fails on SIGTERM when trying to use mini_racer. Ping @zimbatm according to IRC logs.
Assets compilation is now restricted to css only. (Btw asset compilation needs database access which is why it is running in preStart).

The application also doesn't quite like running from other places than its root directory so we "abuse" tmpfiles to create /var/lib/discourse with all the files. I've tried to do this selectively but hit weird errors with rails loader.

Only basic vhost locations are configured and might need improvements according to https://github.com/discourse/discourse/blob/master/config/nginx.sample.conf#L90

Things to do
  • Fix javascript asset compilation (mini_racer SIGTERM)
  • Improve nginx locations
  • Find co-maintainers
  • Consider adding option to enable performance tweaks for pg/redis
Formalities
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.
nixos/modules/services/web-apps/discourse.nix Outdated Show resolved Hide resolved
example = "forum.example.org";
};

package = mkOption {

This comment has been minimized.

@mmilata

mmilata Mar 26, 2020
Member

Do you expect users to choose between packages? If not I'd drop the option, you can always use overlay.

This comment has been minimized.

@sorki

sorki Mar 27, 2020
Author Member

I think this could be handy to set a package with plugins at some point.

nixos/modules/services/web-apps/discourse.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/discourse.nix Outdated Show resolved Hide resolved
nixos/modules/services/web-apps/discourse.nix Outdated Show resolved Hide resolved
};

systemd.tmpfiles.rules = [
"C ${dataDir} - ${user} - - ${cfg.package}/share/discourse"

This comment has been minimized.

@mmilata

mmilata Mar 26, 2020
Member

Will upgrades work when old content is not overwritten by C?

This comment has been minimized.

@sorki

sorki Mar 27, 2020
Author Member

I'm not sure about this approach at all, might be better to do this in PreStart as well.

nixos/modules/services/web-apps/discourse.nix Outdated Show resolved Hide resolved
nixos/tests/discourse.nix Outdated Show resolved Hide resolved

# afterwards generate gemset.nix from repo checkout using
# $ nix-shell -p bundix
# $ bundix

This comment has been minimized.

@mmilata

mmilata Mar 26, 2020
Member

Can these instructions be converted into shell script?:D

This comment has been minimized.

@sorki

sorki Mar 27, 2020
Author Member

Yes, that's the plan

@nixos-discourse
Copy link

@nixos-discourse nixos-discourse commented Mar 26, 2020

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/package-services-for-schools-covidsupport/6335/20

@sorki
Copy link
Member Author

@sorki sorki commented Mar 27, 2020

@ryantm
Copy link
Member

@ryantm ryantm commented Mar 27, 2020

Hi. Thank you for working on this. I'm pretty familiar with Discourse, so I'll try to help out in whatever way I can. Did you consider the approach of managing their Docker container instead of packaging the internals?

@sorki
Copy link
Member Author

@sorki sorki commented Mar 28, 2020

Hi. Thank you for working on this. I'm pretty familiar with Discourse, so I'll try to help out in whatever way I can. Did you consider the approach of managing their Docker container instead of packaging the internals?

Thanks! I've did consider that but it feels like cheating and I think there's a considerable value to be able to deploy w/o Docker:

  • you can tweak parts of the stack easily with Nix and all services use the defaults we're used to
  • security (looks like the base is ubuntu/xenial64, had to look it up as it is not obvious)
  • discourse-docker has a bit exotic layout with launch shell script you use to manage all instances, most of what it (the repo) does is now part of this PRs module

NixOS approach allows for better granularity as you can split each part into its own container or even build Docker containers. Upstream could benefit from this as well since it doesn't look that problematic apart from application data dir issues (as it is not designed to be installed in one place and run at some other state dir, which is not that hard to fix either I guess).

@sorki
Copy link
Member Author

@sorki sorki commented Mar 28, 2020

@GrahamcOfBorg test discourse

@nixos-discourse
Copy link

@nixos-discourse nixos-discourse commented Mar 28, 2020

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/package-services-for-schools-covidsupport/6335/1

@ju1m
Copy link
Contributor

@ju1m ju1m commented Apr 17, 2020

Just to avoid duplicate work, and maybe find co-maintainers, a similar but older PR: #59981

@sorki
Copy link
Member Author

@sorki sorki commented Apr 17, 2020

Thanks, I was searching for this before and while working on it and only found references to IRC logs. Good that it contains few more details about the v8/mini_racer issue.

@stale
Copy link

@stale stale bot commented Oct 14, 2020

Hello, I'm a bot and I thank you in the name of the community for your contributions.

Nixpkgs is a busy repository, and unfortunately sometimes PRs get left behind for too long. Nevertheless, we'd like to help committers reach the PRs that are still important. This PR has had no activity for 180 days, and so I marked it as stale, but you can rest assured it will never be closed by a non-human.

If this is still important to you and you'd like to remove the stale label, we ask that you leave a comment. Your comment can be as simple as "still important to me". But there's a bit more you can do:

If you received an approval by an unprivileged maintainer and you are just waiting for a merge, you can @ mention someone with merge permissions and ask them to help. You might be able to find someone relevant by using Git blame on the relevant files, or via GitHub's web interface. You can see if someone's a member of the nixpkgs-committers team, by hovering with the mouse over their username on the web interface, or by searching them directly on the list.

If your PR wasn't reviewed at all, it might help to find someone who's perhaps a user of the package or module you are changing, or alternatively, ask once more for a review by the maintainer of the package/module this is about. If you don't know any, you can use Git blame on the relevant files, or GitHub's web interface to find someone who touched the relevant files in the past.

If your PR has had reviews and nevertheless got stale, make sure you've responded to all of the reviewer's requests / questions. Usually when PR authors show responsibility and dedication, reviewers (privileged or not) show dedication as well. If you've pushed a change, it's possible the reviewer wasn't notified about your push via email, so you can always officially request them for a review, or just @ mention them and say you've addressed their comments.

Lastly, you can always ask for help at our Discourse Forum, or more specifically, at this thread or at #nixos' IRC channel.

@stale stale bot added the 2.status: stale label Oct 14, 2020
@Sohalt Sohalt mentioned this pull request Oct 19, 2020
0 of 16 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants
You can’t perform that action at this time.