FreedomBox/README.md
Joseph Nuthalapati d30ba771c3
Complete some of the pending changing in renaming some files to .md
In commit d4b4791, four files were renamed by adding a file extension .md
The files are CONTRIBUTING, COPYING, HACKING and INSTALL
This commit fixes the pending tasks and especially the bug where HACKING.md is
wrongly listed as HACKING in debian/plinth.docs and cause build failure for the
Debian package of Plinth

Signed-off-by: Joseph Nuthalapati <njoseph@thoughtworks.com>
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2018-01-05 13:06:31 +05:30

2.9 KiB

Build Status Translation status Debian Unstable Debian Testing Debian Stable

Plinth

Plinth - a web front end for administering FreedomBox

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 your Wi-Fi router, so that your data stays with you.

Plinth is a web interface to administer the functions of the FreedomBox. It is extensible and provides various applications of FreedomBox as modules. Each module or application provides simplified user interface to control the underlying functionality. As FreedomBox can act as a wireless router, it is possible to configure networking from Plinth. Plinth also allows configuration of basic system parameters such as time zone, hostname and automatic upgrades.

You can find more information about Plinth on the Plinth Wiki page, the FreedomBox Wiki and the FreedomBox Manual.

Getting Started

See the INSTALL.md file for additional details and dependencies. To install run:

$ sudo python3 setup.py install

Run Plinth on the local system with:

$ sudo plinth

Contributing

See the HACKING file for contributing to Plinth.

Localization

Translation status