mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-05-20 10:34:30 +00:00
Add documentation for the './run --develop' option
Signed-off-by: Michael Pimmer <info@fonfon.at> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
parent
cab5b694cf
commit
5f033a8ba0
@ -68,13 +68,13 @@ However, for some reason, you wish setup manually, the following tips will help:
|
|||||||
as possible). Simply run it as:
|
as possible). Simply run it as:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ sudo ./run --debug
|
$ sudo ./run --debug --develop
|
||||||
```
|
```
|
||||||
|
|
||||||
In this mode, FreedomBox Service (Plinth) runs in working directory without
|
In this mode, FreedomBox Service (Plinth) runs in working directory without
|
||||||
need for installation. It uses the `plinth.conf` config file in the working
|
need for installation. The `plinth.conf` config file and the action
|
||||||
directory if no regular config file (`/etc/plinth/plinth.conf`) is found. It
|
scripts of the working directory are used. It creates all that data and
|
||||||
creates all that data and runtime files in `data/var/*`.
|
runtime files in `data/var/*`.
|
||||||
|
|
||||||
*Note:* This mode is supported only in a limited manner. The following are
|
*Note:* This mode is supported only in a limited manner. The following are
|
||||||
the unknown issues with it:
|
the unknown issues with it:
|
||||||
|
|||||||
@ -39,6 +39,7 @@
|
|||||||
<arg><option>-h, </option><option>--help</option></arg>
|
<arg><option>-h, </option><option>--help</option></arg>
|
||||||
<arg><option>--server_dir</option><arg choice="req">SERVER_DIR</arg></arg>
|
<arg><option>--server_dir</option><arg choice="req">SERVER_DIR</arg></arg>
|
||||||
<arg><option>--debug</option></arg>
|
<arg><option>--debug</option></arg>
|
||||||
|
<arg><option>--develop</option></arg>
|
||||||
<arg><option>--diagnose</option></arg>
|
<arg><option>--diagnose</option></arg>
|
||||||
<arg>
|
<arg>
|
||||||
<option>--setup</option>
|
<option>--setup</option>
|
||||||
@ -92,11 +93,7 @@
|
|||||||
shipped with a value of <filename>/plinth</filename> in
|
shipped with a value of <filename>/plinth</filename> in
|
||||||
<filename>/etc/plinth/plinth.config</filename>. This
|
<filename>/etc/plinth/plinth.config</filename>. This
|
||||||
means that Plinth will be available as
|
means that Plinth will be available as
|
||||||
http://localhost:8000/plinth by default. When
|
http://localhost:8000/plinth by default.
|
||||||
<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>.
|
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
@ -112,6 +109,16 @@
|
|||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</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>
|
<varlistentry>
|
||||||
<term><option>--diagnose</option></term>
|
<term><option>--diagnose</option></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
@ -200,12 +207,21 @@
|
|||||||
</example>
|
</example>
|
||||||
|
|
||||||
<example>
|
<example>
|
||||||
<title>Run Plinth for debugging</title>
|
<title>Run Plinth with different URL prefix</title>
|
||||||
<synopsis>$ plinth --server_dir=/plinth --debug</synopsis>
|
<synopsis>$ plinth --server_dir='/myurl'</synopsis>
|
||||||
<para>
|
<para>
|
||||||
Enable debug mode and run on terminal. Also override the
|
Run Plinth with the '/myurl' prefix. Note that Apache forwards requests
|
||||||
configuration file value for the URL fragment to start Plinth
|
to '/plinth' by default, so /myurl is not accessible outside of your
|
||||||
under and set it to /plinth.
|
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>
|
</para>
|
||||||
</example>
|
</example>
|
||||||
</refsect1>
|
</refsect1>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user