nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-09-19 04:59:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update manual page with configuration file changes

Browse Source 
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
Sunil Mohan Adapa 2020-06-23 22:45:22 -07:00 committed by James Valleroy
parent 384c34bb3f
commit 60bbdfabf7
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
1 changed files with 16 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/plinth.xml
View File

@ -71,17 +71,10 @@
<term><option>--server_dir SERVER_DIR</option></term> <term><option>--server_dir SERVER_DIR</option></term>
<listitem> <listitem>
<para> <para>
This the URL fragment under which Plinth will provide its This the URL fragment under which Plinth will provide its services.
services. By default the value from Plinth is shipped with a default value of
<filename>plinth.config</filename> is used. Plinth is <filename>/plinth</filename>. This means that Plinth will be
shipped with a value of <filename>/plinth</filename> in available as http://localhost:8000/plinth by default.
<filename>/etc/plinth/plinth.config</filename>. This
means that Plinth will be available as
http://localhost:8000/plinth by default.
When <filename>/etc/plinth/plinth.config</filename> is not
available, <filename>plinth.config</filename> from the current
working directory is used.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -89,9 +82,9 @@
<term><option>--develop</option></term> <term><option>--develop</option></term>
<listitem> <listitem>
<para> <para>
Enable development mode. Use plinth.config and the actions_dir Enable development mode. Use develop.config and action scripts
of the current working directory. Enables extra debug messages, from the current working directory. Enables extra debug messages,
enable Django debug mode for detailed error pages and and turn off enable Django debug mode for detailed error pages and turn off
Django security features. Monitor source files for changes and Django security features. Monitor source files for changes and
restart Plinth on modifications. Die if there is an error during restart Plinth on modifications. Die if there is an error during
module initialization. module initialization.
@ -165,12 +158,15 @@
<refsect1> <refsect1>
<title>Configuration</title> <title>Configuration</title>
<para> <para>
Plinth reads various configuration options from the file Plinth reads various configuration options from the files
<filename>/etc/plinth/plinth.config</filename>. If this file is <filename>/usr/share/freedombox/freedombox.config</filename>,
not present, then it reads configuration file <filename>/usr/share/freedombox/freedombox.config.d/*.config</filename>,
<filename>./plinth.config</filename> from the current directory. <filename>/etc/plinth/plinth.config</filename>,
This is mainly meant to make Plinth work with configuration from <filename>/etc/plinth/plinth.config.d/*.config</filename>,
source code directory for debugging purposes. <filename>/etc/freedombox/freedombox.config</filename> and
<filename>/etc/freedombox/freedombox.config.d/*.config</filename> in that
order. Options in a file read later override options specified earlier.
<filename>/etc/plinth/</filename> locations are deprecated.
</para> </para>
</refsect1> </refsect1>