nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-01-28 08:03:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for the './run --develop' option

Browse Source 
Signed-off-by: Michael Pimmer <info@fonfon.at>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
Michael Pimmer 2018-06-12 15:56:40 +00:00 committed by James Valleroy
parent cab5b694cf
commit 5f033a8ba0
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
2 changed files with 30 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
HACKING.md
View File

@ -68,13 +68,13 @@ However, for some reason, you wish setup manually, the following tips will help:
as possible). Simply run it as:
```
$ sudo ./run --debug
$ sudo ./run --debug --develop
```
In this mode, FreedomBox Service (Plinth) runs in working directory without
need for installation. It uses the `plinth.conf` config file in the working
directory if no regular config file (`/etc/plinth/plinth.conf`) is found. It
creates all that data and runtime files in `data/var/*`.
need for installation. The `plinth.conf` config file and the action
scripts of the working directory are used. It creates all that data and
runtime files in `data/var/*`.
*Note:* This mode is supported only in a limited manner. The following are
the unknown issues with it:

36
doc/plinth.xml
View File

@ -39,6 +39,7 @@
<arg><option>-h, </option><option>--help</option></arg>
<arg><option>--server_dir</option><arg choice="req">SERVER_DIR</arg></arg>
<arg><option>--debug</option></arg>
<arg><option>--develop</option></arg>
<arg><option>--diagnose</option></arg>
<arg>
<option>--setup</option>
@ -92,11 +93,7 @@
shipped with a value of <filename>/plinth</filename> in
<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 current
directory is used. In source directory, this has the
default value of <filename>/</filename>.
http://localhost:8000/plinth by default.
</para>
</listitem>
</varlistentry>
@ -112,6 +109,16 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--develop</option></term>
<listitem>
<para>
Enable development mode. Use plinth.config and the actions_dir
of the current working directory, opposed to the actions_dir
and plinth.config file of the operating system installation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--diagnose</option></term>
<listitem>
@ -200,12 +207,21 @@
</example>
<example>
<title>Run Plinth for debugging</title>
<synopsis>$ plinth --server_dir=/plinth --debug</synopsis>
<title>Run Plinth with different URL prefix</title>
<synopsis>$ plinth --server_dir='/myurl'</synopsis>
<para>
Enable debug mode and run on terminal. Also override the
configuration file value for the URL fragment to start Plinth
under and set it to /plinth.
Run Plinth with the '/myurl' prefix. Note that Apache forwards requests
to '/plinth' by default, so /myurl is not accessible outside of your
FreedomBox without adapting the apache configuration.
</para>
</example>
<example>
<title>Run Plinth in development mode</title>
<synopsis>$ plinth --debug --develop</synopsis>
<para>
Enable debug and development mode and run on terminal. This uses
the configuration and action files of the current working directory.
</para>
</example>
</refsect1>