table of contents
- bookworm 23.6.2+deb12u1
- bookworm-backports 24.25~bpo12+1
- testing 24.26
- unstable 24.26.1
PLINTH(1) | FreedomBox | PLINTH(1) |
NAME¶
plinth - a web front end for administering FreedomBox
SYNOPSIS¶
plinth [-h, --help] [--server_dir {SERVER_DIR}] [--develop] [--diagnose] [--setup [application...]] [--setup-no-install [application...]] [--list-dependencies [application...]]
DESCRIPTION¶
FreedomBox is a community project to develop, design and promote personal servers running free software for private, personal communications. It is a networking appliance designed to allow interfacing with the rest of the Internet under conditions of protected privacy and data security. It hosts applications such as blog, wiki, website, social network, email, web proxy and a Tor relay on a device that can replace a wireless router so that data stays with the users.
Plinth is a web interface to administer the functions of the FreedomBox. It is extensible and is made of modules. Each module provides a simplified user interface to control the underlying functionality of a specific application of FreedomBox. As FreedomBox can act as a wireless router, it is possible to configure networking from Plinth. Plinth allows configuration of basic system parameters such as time zone, hostname and automatic upgrade settings.
OPTIONS¶
--server_dir SERVER_DIR
--develop
--diagnose
--setup
--setup-no-install
--list-dependencies
CONFIGURATION¶
Plinth reads various configuration options from the files /usr/share/freedombox/freedombox.config, /usr/share/freedombox/freedombox.config.d/*.config, /etc/plinth/plinth.config, /etc/plinth/plinth.config.d/*.config, /etc/freedombox/freedombox.config and /etc/freedombox/freedombox.config.d/*.config in that order. Options in a file read later override options specified earlier. /etc/plinth/ locations are deprecated.
EXAMPLES¶
Example 1. Start Plinth with default options
$ plinth
Run Plinth as guided by configuration file.
Example 2. Run Plinth with different URL prefix
$ plinth --server_dir='/myurl'
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.
Example 3. Run Plinth in development mode
$ plinth --develop
Run in development mode on the terminal. Enable auto-reloading and more extensive debugging.
BUGS¶
See Plinth issue tracker[1] for a full list of known issues and TODO items.
AUTHOR¶
Plinth Developers
NOTES¶
- 1.
- Plinth issue tracker
10/08/2024 |