mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
9239d2c627
Compiled templates are an unnecessary pain in maintance and packaging. If each module is to bring its own templates, compiling them in the build process becomes unnecessarily more complex. The current state of template mess can somewhat be attributed to this. Cheetah only partially supports dynamic templates. It does not support inheritence of dynamic templates. From its documentation: "There is no support for extending from a class that is not imported; e.g., from a template dynamically created from a string. Since the most practical way to get a parent template into a module is to precompile it, all parent templates essentially have to be precompiled."
% PLINTH(1) Version 0.1 | Plinth User Manual
%
% February 2011
# Introduction
## Name
plinth - a web front end for administering every aspect of a Freedom Box.
## Synopsis
plinth.py
## Description
The Freedom Box is a net appliance conceived by Eben Moglen. It
contains free software and is designed to allow you to interface with
the rest of the net under conditions of protected privacy and data
security.
The Plinth front end is a web interface to administer the functions of
the Freedom Box. For example, the Freedom Box is a wireless router,
and the front end is where you can adjust its settings.
## Overview
The front end is an extensible web platform for forms and menus. It
allows authenticated users to fill out forms. The interface saves the
form data and from them generates configuration files for the various
services running on the box.
The interface is pluggable. Drop modules into place to add new
capabilities to Plinth and your Freedom Box. Replace existing modules
to get newer, better shinier functions. The modules will
automatically integrate into the existing menu system so you can
control all of the box's parts from one central location.
The interface will eventually have a 'basic' and an 'expert' mode. In
basic mode, much of Plinth's configuration and capability are hidden.
Sane defaults are chosen whenever possible. In expert mode, you can
get down into the details and configure things the average user never
thinks about. For example, experts can turn off ntp or switch ntp
servers. Basic users should never even know those options exist.
## Getting Started
See the INSTALL file for additional details. Run:
$ make
Once make finishes, run Plinth on the local system with:
$ bash start.sh