commit 14cc405a6902bfb929c370e2039f62ba74f4400a · pyrox.dev/nixpkgs

+27 -55

nixos/modules/services/editors/emacs.xml

···

       152
       152
        
       

     

       153
       153
        
       $ ./result/bin/emacs

     

       154
       154
        
       */

     

       155
       155
       -
       { pkgs ? import &lt;nixpkgs&gt; {} }: <co xml:id="ex-emacsNix-1" />

     

       155
       155
       +
       

     

       156
       156
       +
       # The first non-comment line in this file indicates that

     

       157
       157
       +
       # the whole file represents a function.

     

       158
       158
       +
       { pkgs ? import &lt;nixpkgs&gt; {} }:

     

       156
       159
        
       

     

       157
       160
        
       let

     

       158
       158
       -
         myEmacs = pkgs.emacs; <co xml:id="ex-emacsNix-2" />

     

       159
       159
       -
         emacsWithPackages = (pkgs.emacsPackagesFor myEmacs).emacsWithPackages; <co xml:id="ex-emacsNix-3" />

     

       161
       161
       +
         # The let expression below defines a myEmacs binding pointing to the

     

       162
       162
       +
         # current stable version of Emacs. This binding is here to separate

     

       163
       163
       +
         # the choice of the Emacs binary from the specification of the

     

       164
       164
       +
         # required packages.

     

       165
       165
       +
         myEmacs = pkgs.emacs;

     

       166
       166
       +
         # This generates an emacsWithPackages function. It takes a single

     

       167
       167
       +
         # argument: a function from a package set to a list of packages

     

       168
       168
       +
         # (the packages that will be available in Emacs).

     

       169
       169
       +
         emacsWithPackages = (pkgs.emacsPackagesFor myEmacs).emacsWithPackages;

     

       160
       170
        
       in

     

       161
       161
       -
         emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [ <co xml:id="ex-emacsNix-4" />

     

       171
       171
       +
         # The rest of the file specifies the list of packages to install. In the

     

       172
       172
       +
         # example, two packages (magit and zerodark-theme) are taken from

     

       173
       173
       +
         # MELPA stable.

     

       174
       174
       +
         emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [

     

       162
       175
        
           magit          # ; Integrate git &lt;C-x g&gt;

     

       163
       176
        
           zerodark-theme # ; Nicolas' theme

     

       164
       164
       -
         ]) ++ (with epkgs.melpaPackages; [ <co xml:id="ex-emacsNix-5" />

     

       177
       177
       +
         ])

     

       178
       178
       +
         # Two packages (undo-tree and zoom-frm) are taken from MELPA.

     

       179
       179
       +
         ++ (with epkgs.melpaPackages; [

     

       165
       180
        
           undo-tree      # ; &lt;C-x u&gt; to show the undo tree

     

       166
       181
        
           zoom-frm       # ; increase/decrease font size for all buffers %lt;C-x C-+&gt;

     

       167
       167
       -
         ]) ++ (with epkgs.elpaPackages; [ <co xml:id="ex-emacsNix-6" />

     

       182
       182
       +
         ])

     

       183
       183
       +
         # Three packages are taken from GNU ELPA.

     

       184
       184
       +
         ++ (with epkgs.elpaPackages; [

     

       168
       185
        
           auctex         # ; LaTeX mode

     

       169
       186
        
           beacon         # ; highlight my cursor when scrolling

     

       170
       187
        
           nameless       # ; hide current package name everywhere in elisp code

     

       171
       171
       -
         ]) ++ [

     

       172
       172
       -
           pkgs.notmuch   # From main packages set <co xml:id="ex-emacsNix-7" />

     

       188
       188
       +
         ])

     

       189
       189
       +
         # notmuch is taken from a nixpkgs derivation which contains an Emacs mode.

     

       190
       190
       +
         ++ [

     

       191
       191
       +
           pkgs.notmuch   # From main packages set

     

       173
       192
        
         ])

     

       174
       193
        
       </programlisting>

     

       175
       194
        
           </example>

     

       176
       176
       -
           <calloutlist>

     

       177
       177
       -
            <callout arearefs="ex-emacsNix-1">

     

       178
       178
       -
             <para>

     

       179
       179
       -
              The first non-comment line in this file (<literal>{ pkgs ? ...

     

       180
       180
       -
              }</literal>) indicates that the whole file represents a function.

     

       181
       181
       -
             </para>

     

       182
       182
       -
            </callout>

     

       183
       183
       -
            <callout arearefs="ex-emacsNix-2">

     

       184
       184
       -
             <para>

     

       185
       185
       -
              The <varname>let</varname> expression below defines a

     

       186
       186
       -
              <varname>myEmacs</varname> binding pointing to the current stable

     

       187
       187
       -
              version of Emacs. This binding is here to separate the choice of the

     

       188
       188
       -
              Emacs binary from the specification of the required packages.

     

       189
       189
       -
             </para>

     

       190
       190
       -
            </callout>

     

       191
       191
       -
            <callout arearefs="ex-emacsNix-3">

     

       192
       192
       -
             <para>

     

       193
       193
       -
              This generates an <varname>emacsWithPackages</varname> function. It

     

       194
       194
       -
              takes a single argument: a function from a package set to a list of

     

       195
       195
       -
              packages (the packages that will be available in Emacs).

     

       196
       196
       -
             </para>

     

       197
       197
       -
            </callout>

     

       198
       198
       -
            <callout arearefs="ex-emacsNix-4">

     

       199
       199
       -
             <para>

     

       200
       200
       -
              The rest of the file specifies the list of packages to install. In the

     

       201
       201
       -
              example, two packages (<varname>magit</varname> and

     

       202
       202
       -
              <varname>zerodark-theme</varname>) are taken from MELPA stable.

     

       203
       203
       -
             </para>

     

       204
       204
       -
            </callout>

     

       205
       205
       -
            <callout arearefs="ex-emacsNix-5">

     

       206
       206
       -
             <para>

     

       207
       207
       -
              Two packages (<varname>undo-tree</varname> and

     

       208
       208
       -
              <varname>zoom-frm</varname>) are taken from MELPA.

     

       209
       209
       -
             </para>

     

       210
       210
       -
            </callout>

     

       211
       211
       -
            <callout arearefs="ex-emacsNix-6">

     

       212
       212
       -
             <para>

     

       213
       213
       -
              Three packages are taken from GNU ELPA.

     

       214
       214
       -
             </para>

     

       215
       215
       -
            </callout>

     

       216
       216
       -
            <callout arearefs="ex-emacsNix-7">

     

       217
       217
       -
             <para>

     

       218
       218
       -
              <varname>notmuch</varname> is taken from a nixpkgs derivation which

     

       219
       219
       -
              contains an Emacs mode.

     

       220
       220
       -
             </para>

     

       221
       221
       -
            </callout>

     

       222
       222
       -
           </calloutlist>

     

       223
       195
        
          </para>

     

       224
       196
        
       

     

       225
       197
        
          <para>

+27 -56

nixos/modules/services/matrix/synapse.xml

···

       67
       67
        
           recommendedGzipSettings = true;

     

       68
       68
        
           recommendedProxySettings = true;

     

       69
       69
        
           virtualHosts = {

     

       70
       70
       -
             "${config.networking.domain}" = { <co xml:id='ex-matrix-synapse-dns' />

     

       70
       70
       +
             # If the A and AAAA DNS records on example.org do not point on the same host as the

     

       71
       71
       +
             # records for myhostname.example.org, you can easily move the /.well-known

     

       72
       72
       +
             # virtualHost section of the code to the host that is serving example.org, while

     

       73
       73
       +
             # the rest stays on myhostname.example.org with no other changes required.

     

       74
       74
       +
             # This pattern also allows to seamlessly move the homeserver from

     

       75
       75
       +
             # myhostname.example.org to myotherhost.example.org by only changing the

     

       76
       76
       +
             # /.well-known redirection target.

     

       77
       77
       +
             "${config.networking.domain}" = {

     

       71
       78
        
               enableACME = true;

     

       72
       79
        
               forceSSL = true;

     

       73
       73
       -
               locations."= /.well-known/matrix/server".extraConfig = mkWellKnown serverConfig; <co xml:id='ex-matrix-synapse-well-known-server' />

     

       74
       74
       -
               locations."= /.well-known/matrix/client".extraConfig = mkWellKnown clientConfig; <co xml:id='ex-matrix-synapse-well-known-client' />

     

       80
       80
       +
               # This section is not needed if the server_name of matrix-synapse is equal to

     

       81
       81
       +
               # the domain (i.e. example.org from @foo:example.org) and the federation port

     

       82
       82
       +
               # is 8448.

     

       83
       83
       +
               # Further reference can be found in the docs about delegation under

     

       84
       84
       +
               # https://matrix-org.github.io/synapse/latest/delegate.html

     

       85
       85
       +
               locations."= /.well-known/matrix/server".extraConfig = mkWellKnown serverConfig;

     

       86
       86
       +
               # This is usually needed for homeserver discovery (from e.g. other Matrix clients).

     

       87
       87
       +
               # Further reference can be found in the upstream docs at

     

       88
       88
       +
               # https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient

     

       89
       89
       +
               locations."= /.well-known/matrix/client".extraConfig = mkWellKnown clientConfig;

     

       75
       90
        
             };

     

       76
       91
        
             "${fqdn}" = {

     

       77
       92
        
               enableACME = true;

     

       78
       93
        
               forceSSL = true;

     

       79
       79
       -
               locations."/".extraConfig = '' <co xml:id='ex-matrix-synapse-rev-default' />

     

       94
       94
       +
               # It's also possible to do a redirect here or something else, this vhost is not

     

       95
       95
       +
               # needed for Matrix. It's recommended though to *not put* element

     

       96
       96
       +
               # here, see also the section about Element.

     

       97
       97
       +
               locations."/".extraConfig = ''

     

       80
       98
        
                 return 404;

     

       81
       99
        
               '';

     

       82
       82
       -
               locations."/_matrix".proxyPass = "http://[::1]:8008"; <co xml:id='ex-matrix-synapse-rev-proxy-pass' />

     

       83
       83
       -
               locations."/_synapse/client".proxyPass = "http://[::1]:8008"; <co xml:id='ex-matrix-synapse-rev-client' />

     

       100
       100
       +
               # Forward all Matrix API calls to the synapse Matrix homeserver. A trailing slash

     

       101
       101
       +
               # *must not* be used here.

     

       102
       102
       +
               locations."/_matrix".proxyPass = "http://[::1]:8008";

     

       103
       103
       +
               # Forward requests for e.g. SSO and password-resets.

     

       104
       104
       +
               locations."/_synapse/client".proxyPass = "http://[::1]:8008";

     

       84
       105
        
             };

     

       85
       106
        
           };

     

       86
       107
        
         };

     
···

       104
       125
        
       }

     

       105
       126
        
       </programlisting>

     

       106
       127
        
         </para>

     

       107
       107
       -
         <calloutlist>

     

       108
       108
       -
          <callout arearefs='ex-matrix-synapse-dns'>

     

       109
       109
       -
           <para>

     

       110
       110
       -
            If the <code>A</code> and <code>AAAA</code> DNS records on

     

       111
       111
       -
            <literal>example.org</literal> do not point on the same host as the records

     

       112
       112
       -
            for <code>myhostname.example.org</code>, you can easily move the

     

       113
       113
       -
            <code>/.well-known</code> virtualHost section of the code to the host that

     

       114
       114
       -
            is serving <literal>example.org</literal>, while the rest stays on

     

       115
       115
       -
            <literal>myhostname.example.org</literal> with no other changes required.

     

       116
       116
       -
            This pattern also allows to seamlessly move the homeserver from

     

       117
       117
       -
            <literal>myhostname.example.org</literal> to

     

       118
       118
       -
            <literal>myotherhost.example.org</literal> by only changing the

     

       119
       119
       -
            <code>/.well-known</code> redirection target.

     

       120
       120
       -
           </para>

     

       121
       121
       -
          </callout>

     

       122
       122
       -
          <callout arearefs='ex-matrix-synapse-well-known-server'>

     

       123
       123
       -
           <para>

     

       124
       124
       -
            This section is not needed if the <link linkend="opt-services.matrix-synapse.settings.server_name">server_name</link>

     

       125
       125
       -
            of <literal>matrix-synapse</literal> is equal to the domain (i.e.

     

       126
       126
       -
            <literal>example.org</literal> from <literal>@foo:example.org</literal>)

     

       127
       127
       -
            and the federation port is 8448.

     

       128
       128
       -
            Further reference can be found in the <link xlink:href="https://matrix-org.github.io/synapse/latest/delegate.html">docs

     

       129
       129
       -
            about delegation</link>.

     

       130
       130
       -
           </para>

     

       131
       131
       -
          </callout>

     

       132
       132
       -
          <callout arearefs='ex-matrix-synapse-well-known-client'>

     

       133
       133
       -
           <para>

     

       134
       134
       -
            This is usually needed for homeserver discovery (from e.g. other Matrix clients).

     

       135
       135
       -
            Further reference can be found in the <link xlink:href="https://spec.matrix.org/latest/client-server-api/#getwell-knownmatrixclient">upstream docs</link>

     

       136
       136
       -
           </para>

     

       137
       137
       -
          </callout>

     

       138
       138
       -
          <callout arearefs='ex-matrix-synapse-rev-default'>

     

       139
       139
       -
           <para>

     

       140
       140
       -
            It's also possible to do a redirect here or something else, this vhost is not

     

       141
       141
       -
            needed for Matrix. It's recommended though to <emphasis>not put</emphasis> element

     

       142
       142
       -
            here, see also the <link linkend='ex-matrix-synapse-rev-default'>section about Element</link>.

     

       143
       143
       -
           </para>

     

       144
       144
       -
          </callout>

     

       145
       145
       -
          <callout arearefs='ex-matrix-synapse-rev-proxy-pass'>

     

       146
       146
       -
           <para>

     

       147
       147
       -
            Forward all Matrix API calls to the synapse Matrix homeserver. A trailing slash

     

       148
       148
       -
            <emphasis>must not</emphasis> be used here.

     

       149
       149
       -
           </para>

     

       150
       150
       -
          </callout>

     

       151
       151
       -
          <callout arearefs='ex-matrix-synapse-rev-client'>

     

       152
       152
       -
           <para>

     

       153
       153
       -
            Forward requests for e.g. SSO and password-resets.

     

       154
       154
       -
           </para>

     

       155
       155
       -
          </callout>

     

       156
       156
       -
         </calloutlist>

     

       157
       128
        
        </section>

     

       158
       129
        
        <section xml:id="module-services-matrix-register-users">

     

       159
       130
        
         <title>Registering Matrix users</title>

+8 -18

nixos/modules/services/web-apps/plausible.xml

···

       21
       21
        
         services.plausible = {

     

       22
       22
        
           enable = true;

     

       23
       23
        
           adminUser = {

     

       24
       24
       -
             activate = true; <co xml:id='ex-plausible-cfg-activate' />

     

       24
       24
       +
             # activate is used to skip the email verification of the admin-user that's

     

       25
       25
       +
             # automatically created by plausible. This is only supported if

     

       26
       26
       +
             # postgresql is configured by the module. This is done by default, but

     

       27
       27
       +
             # can be turned off with services.plausible.database.postgres.setup.

     

       28
       28
       +
             activate = true;

     

       25
       29
        
             email = "admin@localhost";

     

       26
       30
        
             passwordFile = "/run/secrets/plausible-admin-pwd";

     

       27
       31
        
           };

     

       28
       32
        
           server = {

     

       29
       33
        
             baseUrl = "http://analytics.example.org";

     

       30
       30
       -
             secretKeybaseFile = "/run/secrets/plausible-secret-key-base"; <co xml:id='ex-plausible-cfg-secretbase' />

     

       34
       34
       +
             # secretKeybaseFile is a path to the file which contains the secret generated

     

       35
       35
       +
             # with openssl as described above.

     

       36
       36
       +
             secretKeybaseFile = "/run/secrets/plausible-secret-key-base";

     

       31
       37
        
           };

     

       32
       38
        
         };

     

       33
       39
        
       }

     

       34
       40
        
       </programlisting>

     

       35
       35
       -
          <calloutlist>

     

       36
       36
       -
           <callout arearefs='ex-plausible-cfg-activate'>

     

       37
       37
       -
            <para>

     

       38
       38
       -
             <varname>activate</varname> is used to skip the email verification of the admin-user that's

     

       39
       39
       -
             automatically created by <package>plausible</package>. This is only supported if

     

       40
       40
       -
             <package>postgresql</package> is configured by the module. This is done by default, but

     

       41
       41
       -
             can be turned off with <xref linkend="opt-services.plausible.database.postgres.setup" />.

     

       42
       42
       -
            </para>

     

       43
       43
       -
           </callout>

     

       44
       44
       -
           <callout arearefs='ex-plausible-cfg-secretbase'>

     

       45
       45
       -
            <para>

     

       46
       46
       -
             <varname>secretKeybaseFile</varname> is a path to the file which contains the secret generated

     

       47
       47
       -
             with <package>openssl</package> as described above.

     

       48
       48
       -
            </para>

     

       49
       49
       -
           </callout>

     

       50
       50
       -
          </calloutlist>

     

       51
       41
        
         </para>

     

       52
       42
        
        </section>

     

       53
       43
        
       </chapter>