diff options
Diffstat (limited to 'nixos/modules/services/web-apps/discourse.xml')
| -rw-r--r-- | nixos/modules/services/web-apps/discourse.xml | 57 |
1 files changed, 27 insertions, 30 deletions
diff --git a/nixos/modules/services/web-apps/discourse.xml b/nixos/modules/services/web-apps/discourse.xml index 1aec160b7b40a..ff7534ba5a5aa 100644 --- a/nixos/modules/services/web-apps/discourse.xml +++ b/nixos/modules/services/web-apps/discourse.xml @@ -36,8 +36,8 @@ security.acme.acceptTerms = true; <title>Using a regular TLS certificate</title> <para> To set up TLS using a regular certificate and key on file, use the - <xref linkend="opt-services.discourse.sslCertificate"></xref> and - <xref linkend="opt-services.discourse.sslCertificateKey"></xref> + <xref linkend="opt-services.discourse.sslCertificate" /> and + <xref linkend="opt-services.discourse.sslCertificateKey" /> options: </para> <programlisting> @@ -61,22 +61,20 @@ services.discourse = { <para> Discourse uses PostgreSQL to store most of its data. A database will automatically be enabled and a database and role created - unless - <xref linkend="opt-services.discourse.database.host"></xref> is + unless <xref linkend="opt-services.discourse.database.host" /> is changed from its default of <literal>null</literal> or - <xref linkend="opt-services.discourse.database.createLocally"></xref> + <xref linkend="opt-services.discourse.database.createLocally" /> is set to <literal>false</literal>. </para> <para> External database access can also be configured by setting - <xref linkend="opt-services.discourse.database.host"></xref>, - <xref linkend="opt-services.discourse.database.username"></xref> - and - <xref linkend="opt-services.discourse.database.passwordFile"></xref> - as appropriate. Note that you need to manually create a database + <xref linkend="opt-services.discourse.database.host" />, + <xref linkend="opt-services.discourse.database.username" /> and + <xref linkend="opt-services.discourse.database.passwordFile" /> as + appropriate. Note that you need to manually create a database called <literal>discourse</literal> (or the name you chose in - <xref linkend="opt-services.discourse.database.name"></xref>) and - allow the configured database user full access to it. + <xref linkend="opt-services.discourse.database.name" />) and allow + the configured database user full access to it. </para> </section> <section xml:id="module-services-discourse-mail"> @@ -127,19 +125,18 @@ services.discourse = { If you want to use a different domain for your outgoing email (for example <literal>example.com</literal> instead of <literal>discourse.example.com</literal>) you should set - <xref linkend="opt-services.discourse.mail.notificationEmailAddress"></xref> + <xref linkend="opt-services.discourse.mail.notificationEmailAddress" /> and - <xref linkend="opt-services.discourse.mail.contactEmailAddress"></xref> + <xref linkend="opt-services.discourse.mail.contactEmailAddress" /> manually. </para> <note> <para> Setup of TLS for incoming email is currently only configured - automatically when a regular TLS certificate is used, i.e. when - <xref linkend="opt-services.discourse.sslCertificate"></xref> - and - <xref linkend="opt-services.discourse.sslCertificateKey"></xref> - are set. + automatically when a regular TLS certificate is used, i.e. when + <xref linkend="opt-services.discourse.sslCertificate" /> and + <xref linkend="opt-services.discourse.sslCertificateKey" /> are + set. </para> </note> </section> @@ -148,8 +145,8 @@ services.discourse = { <para> Additional site settings and backend settings, for which no explicit NixOS options are provided, can be set in - <xref linkend="opt-services.discourse.siteSettings"></xref> and - <xref linkend="opt-services.discourse.backendSettings"></xref> + <xref linkend="opt-services.discourse.siteSettings" /> and + <xref linkend="opt-services.discourse.backendSettings" /> respectively. </para> <section xml:id="module-services-discourse-site-settings"> @@ -158,15 +155,15 @@ services.discourse = { <quote>Site settings</quote> are the settings that can be changed through the Discourse UI. Their <emphasis>default</emphasis> values can be set using - <xref linkend="opt-services.discourse.siteSettings"></xref>. + <xref linkend="opt-services.discourse.siteSettings" />. </para> <para> Settings are expressed as a Nix attribute set which matches the structure of the configuration in <link xlink:href="https://github.com/discourse/discourse/blob/master/config/site_settings.yml">config/site_settings.yml</link>. To find a setting’s path, you only need to care about the first - two levels; i.e. its category (e.g. <literal>login</literal>) - and name (e.g. <literal>invite_only</literal>). + two levels; i.e. its category (e.g. <literal>login</literal>) + and name (e.g. <literal>invite_only</literal>). </para> <para> Settings containing secret data should be set to an attribute @@ -245,12 +242,12 @@ services.discourse = { <title>Plugins</title> <para> You can install Discourse plugins using the - <xref linkend="opt-services.discourse.plugins"></xref> option. + <xref linkend="opt-services.discourse.plugins" /> option. Pre-packaged plugins are provided in <literal><your_discourse_package_here>.plugins</literal>. If you want the full suite of plugins provided through <literal>nixpkgs</literal>, you can also set the - <xref linkend="opt-services.discourse.package"></xref> option to + <xref linkend="opt-services.discourse.package" /> option to <literal>pkgs.discourseAllPlugins</literal>. </para> <para> @@ -284,10 +281,10 @@ services.discourse = { Some plugins provide <link linkend="module-services-discourse-site-settings">site settings</link>. Their defaults can be configured using - <xref linkend="opt-services.discourse.siteSettings"></xref>, just - like regular site settings. To find the names of these settings, - look in the <literal>config/settings.yml</literal> file of the - plugin repo. + <xref linkend="opt-services.discourse.siteSettings" />, just like + regular site settings. To find the names of these settings, look + in the <literal>config/settings.yml</literal> file of the plugin + repo. </para> <para> For example, to add the |