mirror of
https://github.com/ilyakooo0/nixpkgs.git
synced 2024-09-20 03:59:30 +03:00
Manual: Start of module-specific documentation
This commit is contained in:
parent
39df234f65
commit
41788255ab
@ -24,6 +24,9 @@ effect after you run <command>nixos-rebuild</command>.</para>
|
||||
<xi:include href="networking.xml" />
|
||||
<xi:include href="linux-kernel.xml" />
|
||||
|
||||
<!-- FIXME: auto-include NixOS module docs -->
|
||||
<xi:include href="postgresql.xml" />
|
||||
|
||||
<!-- Apache; libvirtd virtualisation -->
|
||||
|
||||
</part>
|
||||
|
@ -41,6 +41,8 @@ let
|
||||
copySources =
|
||||
''
|
||||
cp -prd $sources/* . # */
|
||||
chmod -R u+w .
|
||||
cp ${../../modules/services/databases/postgresql.xml} configuration/postgresql.xml
|
||||
ln -s ${optionsDocBook} options-db.xml
|
||||
echo "${version}" > version
|
||||
'';
|
||||
@ -74,7 +76,7 @@ in rec {
|
||||
--param toc.section.depth 3 \
|
||||
--stringparam admon.style "" \
|
||||
--stringparam callout.graphics.extension .gif \
|
||||
--param chunk.section.depth 1 \
|
||||
--param chunk.section.depth 0 \
|
||||
--param chunk.first.sections 1 \
|
||||
--param use.id.as.filename 1 \
|
||||
--stringparam generate.toc "book toc chapter toc appendix toc" \
|
||||
|
77
nixos/modules/services/databases/postgresql.xml
Normal file
77
nixos/modules/services/databases/postgresql.xml
Normal file
@ -0,0 +1,77 @@
|
||||
<chapter xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude"
|
||||
version="5.0"
|
||||
xml:id="module-postgresql">
|
||||
|
||||
<title>PostgreSQL</title>
|
||||
|
||||
<!-- FIXME: render nicely -->
|
||||
|
||||
<!-- FIXME: source can be added automatically -->
|
||||
<para><emphasis>Source:</emphasis> <filename>modules/services/databases/postgresql.nix</filename></para>
|
||||
|
||||
<para><emphasis>Upstream documentation:</emphasis> <link xlink:href="http://www.postgresql.org/docs/"/></para>
|
||||
|
||||
<!-- FIXME: more stuff, like maintainer? -->
|
||||
|
||||
<para>PostgreSQL is an advanced, free relational database.<!-- MORE --></para>
|
||||
|
||||
<section><title>Configuring</title>
|
||||
|
||||
<para>To enable PostgreSQL, add the following to your
|
||||
<filename>configuration.nix</filename>:
|
||||
|
||||
<programlisting>
|
||||
services.postgresql.enable = true;
|
||||
services.postgresql.package = pkgs.postgresql93;
|
||||
</programlisting>
|
||||
|
||||
Note that you are required to specify the desired version of
|
||||
PostgreSQL (e.g. <literal>pkgs.postgresql93</literal>). Since
|
||||
upgrading your PostgreSQL version requires a database dump and reload
|
||||
(see below), NixOS cannot provide a default value for
|
||||
<option>services.postgresql.package</option> such as the most recent
|
||||
release of PostgreSQL.</para>
|
||||
|
||||
<!--
|
||||
<para>After running <command>nixos-rebuild</command>, you can verify
|
||||
whether PostgreSQL works by running <command>psql</command>:
|
||||
|
||||
<screen>
|
||||
$ psql
|
||||
psql (9.2.9)
|
||||
Type "help" for help.
|
||||
|
||||
alice=>
|
||||
</screen>
|
||||
-->
|
||||
|
||||
<para>By default, PostgreSQL stores its databases in
|
||||
<filename>/var/db/postgresql</filename>. You can override this using
|
||||
<option>services.postgresql.dataDir</option>, e.g.
|
||||
|
||||
<programlisting>
|
||||
services.postgresql.dataDir = "/data/postgresql";
|
||||
</programlisting>
|
||||
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section><title>Upgrading</title>
|
||||
|
||||
<para>FIXME: document dump/upgrade/load cycle.</para>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
<section><title>Options</title>
|
||||
|
||||
<para>FIXME: auto-generated list of module options.</para>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
</chapter>
|
Loading…
Reference in New Issue
Block a user