commit 25ec23b9aa34a7f387a7bc0ff7c9a87e9742f606 · pyrox.dev/nixpkgs

+9 -9

nixos/modules/services/editors/emacs.xml

···

       20
        
        <para>

     

       21
        
         Emacs runs within a graphical desktop environment using the X Window System,

     

       22
        
         but works equally well on a text terminal. Under

     

       23
       -
         <productname>macOS</productname>, a "Mac port" edition is available, which

     

       24
        
         uses Apple's native GUI frameworks.

     

       25
        
        </para>

     

       26
        
        <para>

     

       27
       -
         <productname>Nixpkgs</productname> provides a superior environment for

     

       28
       -
         running <application>Emacs</application>. It's simple to create custom builds

     

       29
        
         by overriding the default packages. Chaotic collections of Emacs Lisp code

     

       30
        
         and extensions can be brought under control using declarative package

     

       31
       -
         management. <productname>NixOS</productname> even provides a

     

       32
        
         <command>systemd</command> user service for automatically starting the Emacs

     

       33
        
         daemon.

     

       34
        
        </para>

     

       35
        
        <section xml:id="module-services-emacs-installing">

     

       36
       -
         <title>Installing <application>Emacs</application></title>

     

       37
        
       

     

       38
        
         <para>

     

       39
        
          Emacs can be installed in the normal way for Nix (see

     
···

       45
        
          <title>The Different Releases of Emacs</title>

     

       46
        
       

     

       47
        
          <para>

     

       48
       -
           <productname>Nixpkgs</productname> defines several basic Emacs packages.

     

       49
        
           The following are attributes belonging to the <varname>pkgs</varname> set:

     

       50
        
           <variablelist>

     

       51
        
            <varlistentry>

     
···

       115
        
           (<filename>package.el</filename>) from

     

       116
        
           <link

     

       117
        
               xlink:href="https://elpa.gnu.org/">Emacs Lisp Package Archive

     

       118
       -
           (<acronym>ELPA</acronym>)</link>,

     

       119
       -
           <link xlink:href="https://melpa.org/"><acronym>MELPA</acronym></link>,

     

       120
        
           <link xlink:href="https://stable.melpa.org/">MELPA Stable</link>, and

     

       121
        
           <link xlink:href="http://orgmode.org/elpa.html">Org ELPA</link>. Nixpkgs is

     

       122
        
           regularly updated to mirror all these archives.

     
···

       357
        
         <title>Running Emacs as a Service</title>

     

       358
        
       

     

       359
        
         <para>

     

       360
       -
          <productname>NixOS</productname> provides an optional

     

       361
        
          <command>systemd</command> service which launches

     

       362
        
          <link xlink:href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html">

     

       363
        
          Emacs daemon </link> with the user's login session.

···

       20
        
        <para>

     

       21
        
         Emacs runs within a graphical desktop environment using the X Window System,

     

       22
        
         but works equally well on a text terminal. Under

     

       23
       +
         macOS, a "Mac port" edition is available, which

     

       24
        
         uses Apple's native GUI frameworks.

     

       25
        
        </para>

     

       26
        
        <para>

     

       27
       +
         Nixpkgs provides a superior environment for

     

       28
       +
         running Emacs. It's simple to create custom builds

     

       29
        
         by overriding the default packages. Chaotic collections of Emacs Lisp code

     

       30
        
         and extensions can be brought under control using declarative package

     

       31
       +
         management. NixOS even provides a

     

       32
        
         <command>systemd</command> user service for automatically starting the Emacs

     

       33
        
         daemon.

     

       34
        
        </para>

     

       35
        
        <section xml:id="module-services-emacs-installing">

     

       36
       +
         <title>Installing Emacs</title>

     

       37
        
       

     

       38
        
         <para>

     

       39
        
          Emacs can be installed in the normal way for Nix (see

     
···

       45
        
          <title>The Different Releases of Emacs</title>

     

       46
        
       

     

       47
        
          <para>

     

       48
       +
           Nixpkgs defines several basic Emacs packages.

     

       49
        
           The following are attributes belonging to the <varname>pkgs</varname> set:

     

       50
        
           <variablelist>

     

       51
        
            <varlistentry>

     
···

       115
        
           (<filename>package.el</filename>) from

     

       116
        
           <link

     

       117
        
               xlink:href="https://elpa.gnu.org/">Emacs Lisp Package Archive

     

       118
       +
           (ELPA)</link>,

     

       119
       +
           <link xlink:href="https://melpa.org/">MELPA</link>,

     

       120
        
           <link xlink:href="https://stable.melpa.org/">MELPA Stable</link>, and

     

       121
        
           <link xlink:href="http://orgmode.org/elpa.html">Org ELPA</link>. Nixpkgs is

     

       122
        
           regularly updated to mirror all these archives.

     
···

       357
        
         <title>Running Emacs as a Service</title>

     

       358
        
       

     

       359
        
         <para>

     

       360
       +
          NixOS provides an optional

     

       361
        
          <command>systemd</command> service which launches

     

       362
        
          <link xlink:href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.html">

     

       363
        
          Emacs daemon </link> with the user's login session.

+2 -2

nixos/modules/services/matrix/synapse.xml

···

       167
        
          and have rebuilt NixOS:

     

       168
        
       <screen>

     

       169
        
       <prompt>$ </prompt>nix-shell -p matrix-synapse

     

       170
       -
       <prompt>$ </prompt>register_new_matrix_user -k <replaceable>your-registration-shared-secret</replaceable> http://localhost:8008

     

       171
       -
       <prompt>New user localpart: </prompt><replaceable>your-username</replaceable>

     

       172
        
       <prompt>Password:</prompt>

     

       173
        
       <prompt>Confirm password:</prompt>

     

       174
        
       <prompt>Make admin [no]:</prompt>

···

       167
        
          and have rebuilt NixOS:

     

       168
        
       <screen>

     

       169
        
       <prompt>$ </prompt>nix-shell -p matrix-synapse

     

       170
       +
       <prompt>$ </prompt>register_new_matrix_user -k your-registration-shared-secret http://localhost:8008

     

       171
       +
       <prompt>New user localpart: </prompt>your-username

     

       172
        
       <prompt>Password:</prompt>

     

       173
        
       <prompt>Confirm password:</prompt>

     

       174
        
       <prompt>Make admin [no]:</prompt>

+9 -9

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

···

       68
        
        <section xml:id="module-services-discourse-database">

     

       69
        
          <title>Database access</title>

     

       70
        
          <para>

     

       71
       -
            <productname>Discourse</productname> uses

     

       72
       -
            <productname>PostgreSQL</productname> to store most of its

     

       73
        
            data. A database will automatically be enabled and a database

     

       74
        
            and role created unless <xref

     

       75
        
            linkend="opt-services.discourse.database.host" /> is changed from

     
···

       94
        
          <title>Email</title>

     

       95
        
          <para>

     

       96
        
            In addition to the basic setup, you'll want to configure an SMTP

     

       97
       -
            server <productname>Discourse</productname> can use to send user

     

       98
        
            registration and password reset emails, among others. You can

     

       99
       -
            also optionally let <productname>Discourse</productname> receive

     

       100
        
            email, which enables people to reply to threads and conversations

     

       101
        
            via email.

     

       102
        
          </para>

     
···

       159
        
          <title>Additional settings</title>

     

       160
        
          <para>

     

       161
        
            Additional site settings and backend settings, for which no

     

       162
       -
            explicit <productname>NixOS</productname> options are provided,

     

       163
        
            can be set in <xref linkend="opt-services.discourse.siteSettings" /> and

     

       164
        
            <xref linkend="opt-services.discourse.backendSettings" /> respectively.

     

       165
        
          </para>

     
···

       168
        
            <title>Site settings</title>

     

       169
        
            <para>

     

       170
        
              "Site settings" are the settings that can be

     

       171
       -
              changed through the <productname>Discourse</productname>

     

       172
        
              UI. Their <emphasis>default</emphasis> values can be set using

     

       173
        
              <xref linkend="opt-services.discourse.siteSettings" />.

     

       174
        
            </para>

     
···

       205
        
            <title>Example</title>

     

       206
        
            <para>

     

       207
        
              The following example sets the title and description of the

     

       208
       -
              <productname>Discourse</productname> instance and enables

     

       209
       -
              <productname>GitHub</productname> login in the site settings,

     

       210
        
              and changes a few request limits in the backend settings:

     

       211
        
       <programlisting>

     

       212
        
       services.discourse = {

     
···

       260
        
         <section xml:id="module-services-discourse-plugins">

     

       261
        
           <title>Plugins</title>

     

       262
        
           <para>

     

       263
       -
             You can install <productname>Discourse</productname> plugins

     

       264
        
             using the <xref linkend="opt-services.discourse.plugins" />

     

       265
        
             option. Pre-packaged plugins are provided in

     

       266
        
             <literal>&lt;your_discourse_package_here&gt;.plugins</literal>. If

···

       68
        
        <section xml:id="module-services-discourse-database">

     

       69
        
          <title>Database access</title>

     

       70
        
          <para>

     

       71
       +
            Discourse uses

     

       72
       +
            PostgreSQL to store most of its

     

       73
        
            data. A database will automatically be enabled and a database

     

       74
        
            and role created unless <xref

     

       75
        
            linkend="opt-services.discourse.database.host" /> is changed from

     
···

       94
        
          <title>Email</title>

     

       95
        
          <para>

     

       96
        
            In addition to the basic setup, you'll want to configure an SMTP

     

       97
       +
            server Discourse can use to send user

     

       98
        
            registration and password reset emails, among others. You can

     

       99
       +
            also optionally let Discourse receive

     

       100
        
            email, which enables people to reply to threads and conversations

     

       101
        
            via email.

     

       102
        
          </para>

     
···

       159
        
          <title>Additional settings</title>

     

       160
        
          <para>

     

       161
        
            Additional site settings and backend settings, for which no

     

       162
       +
            explicit NixOS options are provided,

     

       163
        
            can be set in <xref linkend="opt-services.discourse.siteSettings" /> and

     

       164
        
            <xref linkend="opt-services.discourse.backendSettings" /> respectively.

     

       165
        
          </para>

     
···

       168
        
            <title>Site settings</title>

     

       169
        
            <para>

     

       170
        
              "Site settings" are the settings that can be

     

       171
       +
              changed through the Discourse

     

       172
        
              UI. Their <emphasis>default</emphasis> values can be set using

     

       173
        
              <xref linkend="opt-services.discourse.siteSettings" />.

     

       174
        
            </para>

     
···

       205
        
            <title>Example</title>

     

       206
        
            <para>

     

       207
        
              The following example sets the title and description of the

     

       208
       +
              Discourse instance and enables

     

       209
       +
              GitHub login in the site settings,

     

       210
        
              and changes a few request limits in the backend settings:

     

       211
        
       <programlisting>

     

       212
        
       services.discourse = {

     
···

       260
        
         <section xml:id="module-services-discourse-plugins">

     

       261
        
           <title>Plugins</title>

     

       262
        
           <para>

     

       263
       +
             You can install Discourse plugins

     

       264
        
             using the <xref linkend="opt-services.discourse.plugins" />

     

       265
        
             option. Pre-packaged plugins are provided in

     

       266
        
             <literal>&lt;your_discourse_package_here&gt;.plugins</literal>. If

+7 -7

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

···

       29
        
              Refer to the <link

     

       30
        
              xlink:href="https://www.keycloak.org/docs/latest/server_admin/index.html">

     

       31
        
              Keycloak Server Administration Guide</link> for information on

     

       32
       -
              how to administer your <productname>Keycloak</productname>

     

       33
        
              instance.

     

       34
        
            </para>

     

       35
        
          </section>

     
···

       37
        
          <section xml:id="module-services-keycloak-database">

     

       38
        
            <title>Database access</title>

     

       39
        
            <para>

     

       40
       -
              <productname>Keycloak</productname> can be used with either

     

       41
       -
              <productname>PostgreSQL</productname>,

     

       42
       -
              <productname>MariaDB</productname> or

     

       43
       -
              <productname>MySQL</productname>. Which one is used can be

     

       44
        
              configured in <xref

     

       45
        
              linkend="opt-services.keycloak.database.type" />. The selected

     

       46
        
              database will automatically be enabled and a database and role

     
···

       103
        
              <xref linkend="opt-services.keycloak.settings.hostname-strict-backchannel" />

     

       104
        
              determines whether Keycloak should force all requests to go

     

       105
        
              through the frontend URL. By default,

     

       106
       -
              <productname>Keycloak</productname> allows backend requests to

     

       107
        
              instead use its local hostname or IP address and may also

     

       108
        
              advertise it to clients through its OpenID Connect Discovery

     

       109
        
              endpoint.

     
···

       120
        
          <section xml:id="module-services-keycloak-tls">

     

       121
        
            <title>Setting up TLS/SSL</title>

     

       122
        
            <para>

     

       123
       -
              By default, <productname>Keycloak</productname> won't accept

     

       124
        
              unsecured HTTP connections originating from outside its local

     

       125
        
              network.

     

       126
        
            </para>

···

       29
        
              Refer to the <link

     

       30
        
              xlink:href="https://www.keycloak.org/docs/latest/server_admin/index.html">

     

       31
        
              Keycloak Server Administration Guide</link> for information on

     

       32
       +
              how to administer your Keycloak

     

       33
        
              instance.

     

       34
        
            </para>

     

       35
        
          </section>

     
···

       37
        
          <section xml:id="module-services-keycloak-database">

     

       38
        
            <title>Database access</title>

     

       39
        
            <para>

     

       40
       +
              Keycloak can be used with either

     

       41
       +
              PostgreSQL,

     

       42
       +
              MariaDB or

     

       43
       +
              MySQL. Which one is used can be

     

       44
        
              configured in <xref

     

       45
        
              linkend="opt-services.keycloak.database.type" />. The selected

     

       46
        
              database will automatically be enabled and a database and role

     
···

       103
        
              <xref linkend="opt-services.keycloak.settings.hostname-strict-backchannel" />

     

       104
        
              determines whether Keycloak should force all requests to go

     

       105
        
              through the frontend URL. By default,

     

       106
       +
              Keycloak allows backend requests to

     

       107
        
              instead use its local hostname or IP address and may also

     

       108
        
              advertise it to clients through its OpenID Connect Discovery

     

       109
        
              endpoint.

     
···

       120
        
          <section xml:id="module-services-keycloak-tls">

     

       121
        
            <title>Setting up TLS/SSL</title>

     

       122
        
            <para>

     

       123
       +
              By default, Keycloak won't accept

     

       124
        
              unsecured HTTP connections originating from outside its local

     

       125
        
              network.

     

       126
        
            </para>

+1 -1

nixos/modules/services/x11/desktop-managers/pantheon.xml

···

       85
        
           </term>

     

       86
        
           <listitem>

     

       87
        
            <para>

     

       88
       -
             Open Switchboard and go to: <guilabel>Administration</guilabel> → <guilabel>About</guilabel> → <guilabel>Restore Default Settings</guilabel> → <guibutton>Restore Settings</guibutton>. This will reset any dconf settings to their Pantheon defaults. Note this could reset certain GNOME specific preferences if that desktop was used prior.

     

       89
        
            </para>

     

       90
        
           </listitem>

     

       91
        
          </varlistentry>

···

       85
        
           </term>

     

       86
        
           <listitem>

     

       87
        
            <para>

     

       88
       +
             Open Switchboard and go to: Administration → About → Restore Default Settings → Restore Settings. This will reset any dconf settings to their Pantheon defaults. Note this could reset certain GNOME specific preferences if that desktop was used prior.

     

       89
        
            </para>

     

       90
        
           </listitem>

     

       91
        
          </varlistentry>