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

nixos/matrix: write manual section #57699

Merged
merged 1 commit into from Mar 16, 2019

Conversation

Projects
None yet
4 participants
@florianjacob
Copy link
Contributor

commented Mar 15, 2019

Motivation for this change

This was developed as part of
#55320 (comment)
with the initial intention to show users how to set up a synapse homeserver with a valid certificate, in light of the upcoming 1.0 release.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • 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 nox --run "nox-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)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@florianjacob

This comment has been minimized.

Copy link
Contributor Author

commented Mar 15, 2019

@Ekleog this is yet missing a changelog entry / edit of the matrix-synapse 1.0 changelog warning you mentioned in #55320 (comment), depending on whether this can still go in 19.03.

@florianjacob

This comment has been minimized.

Copy link
Contributor Author

commented Mar 15, 2019

Other synapse maintainers: @Ralith @roblabla
riot-web maintainer: @bachp

@Ekleog
Copy link
Member

left a comment

@florianjacob As this is a manual change only, I'm pretty sure it'll be OK to backport, so feel free to add a link to the 19.03 changelog :) I'll merge once the link is added and @pacien 's comments are addressed, thanks a lot!

<programlisting>
let
fqdn = let
join = hostName: domain: hostName + optionalString (domain != null) ".${domain}";

This comment has been minimized.

Copy link
@Ekleog

Ekleog Mar 15, 2019

Member

Potentially personal opinion ahead: I feel that this let should be after the line break. Feel free to ignore, though, we still don't have any kind of style guide for the time being.

This comment has been minimized.

Copy link
@florianjacob

florianjacob Mar 16, 2019

Author Contributor

You mean like this?

let
  fqdn =
    let
      join = hostName: domain: hostName + optionalString (domain != null) ".${domain}";
    in join config.networking.hostName config.networking.domain;
in {

};

Changed to this style now, the other two bindings as well.

I always struggle to format let bindings. :/ Any good example would be appreciated, as almost any let binding you find in nixpkgs is formatted differently… Can't wait for an actual style guide.

This comment has been minimized.

Copy link
@Ekleog

Ekleog Mar 16, 2019

Member

Looks great this way, thanks! Totally agree we definitely need a style guide; currently the most frequent formattings I see are these, I think (but I'm likely biased by my own personal preferences):

{
  a = let foo = bar; in baz;
  b =
    let foo = bar;
    in baz;
  c =
    let
      foo = bar;
    in baz;
  d =
    let
      foo = bar;
    in
      baz;
  e =
    let
      foo = bar;
    in
    baz; # mostly used to stay at column 0
}

This comment has been minimized.

Copy link
@florianjacob

florianjacob Mar 16, 2019

Author Contributor

Those styles look very reasonable, thank you. 👍

Show resolved Hide resolved nixos/doc/manual/configuration/matrix.xml Outdated
nixos/matrix: add manual section
about self-hosting a matrix client and server

@florianjacob florianjacob force-pushed the florianjacob:matrix-doc branch from 008a077 to ef52869 Mar 16, 2019

@florianjacob

This comment has been minimized.

Copy link
Contributor Author

commented Mar 16, 2019

Thanks to all for their feedback and review,
@Ekleog just pushed all requested changes, now with changelog entries for 19.03 and link to manual chapter.

@Ekleog

This comment has been minimized.

Copy link
Member

commented Mar 16, 2019

@florianjacob Thank you! Merged and backported as 4e8ace1. If someone has further issues with this, it can be fixed as an additional PR I think :)

@Ekleog Ekleog merged commit ef52869 into NixOS:master Mar 16, 2019

10 checks passed

grahamcofborg-eval ^.^!
Details
grahamcofborg-eval-check-maintainers matching changed paths to changed attrs...
Details
grahamcofborg-eval-check-meta config.nix: checkMeta = true
Details
grahamcofborg-eval-nixos-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release.nix -A manual
Details
grahamcofborg-eval-nixos-options nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./nixos/release.nix -A options
Details
grahamcofborg-eval-nixpkgs-manual nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A manual
Details
grahamcofborg-eval-nixpkgs-tarball nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A tarball
Details
grahamcofborg-eval-nixpkgs-unstable-jobset nix-instantiate --arg nixpkgs { outPath=./.; revCount=999999; shortRev="ofborg"; } ./pkgs/top-level/release.nix -A unstable
Details
grahamcofborg-eval-package-list nix-env -qa --json --file .
Details
grahamcofborg-eval-package-list-no-aliases nix-env -qa --json --file . --arg config { allowAliases = false; }
Details

@florianjacob florianjacob deleted the florianjacob:matrix-doc branch Mar 16, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.