diff --git a/HACKING.md b/HACKING.md
index 74a6eedcb..9b1ffe68a 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -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:
diff --git a/doc/plinth.xml b/doc/plinth.xml
index 40412c405..6a533b293 100644
--- a/doc/plinth.xml
+++ b/doc/plinth.xml
@@ -39,6 +39,7 @@
SERVER_DIR
+
@@ -92,11 +93,7 @@
shipped with a value of /plinth in
/etc/plinth/plinth.config. This
means that Plinth will be available as
- http://localhost:8000/plinth by default. When
- /etc/plinth/plinth.config is not
- available, plinth.config from current
- directory is used. In source directory, this has the
- default value of /.
+ http://localhost:8000/plinth by default.
@@ -112,6 +109,16 @@
+
+
+
+
+ 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.
+
+
+
@@ -200,12 +207,21 @@
- Run Plinth for debugging
- $ plinth --server_dir=/plinth --debug
+ Run Plinth with different URL prefix
+ $ plinth --server_dir='/myurl'
- 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.
+
+
+
+
+ Run Plinth in development mode
+ $ plinth --debug --develop
+
+ Enable debug and development mode and run on terminal. This uses
+ the configuration and action files of the current working directory.