mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
f097047b8b
Twitter Bootstrap provides good styling for forms. Our current theme does not ouput forms in bootstrap styles although for everything else, it does. The python-bootstrap from is a simple Django helper application to render Django forms into bootstrap theme. Django forms themselves provide numerous advantages over the current incomplete homegrown solution. It also has solutions for problems such as CSRF attacks which the current application is vulnerable to.
50 lines
1.3 KiB
Plaintext
50 lines
1.3 KiB
Plaintext
# Quick Start
|
|
|
|
## Installing Plinth
|
|
|
|
Install the pandoc, python-augeas, and bjsonrpc:
|
|
|
|
apt-get install augeas-tools libpython2.7 pandoc psmisc python2.7 python-augeas python-bcrypt python-bjsonrpc python-cherrypy3 python-django python-passlib python-simplejson python-bootstrapform sudo
|
|
|
|
Unzip and untar the source into a directory. Change to the directory
|
|
containing the program. Run:
|
|
|
|
$ make
|
|
|
|
To start Plinth, run:
|
|
|
|
$ ./start.sh
|
|
|
|
and point your web browser at `localhost:8000`. The default username is "admin"
|
|
and the default password is "secret".
|
|
|
|
## Dependencies
|
|
|
|
* cherrypy - python web engine v3+
|
|
|
|
* python - tested with version 2.6.6
|
|
|
|
* *GNU Make* is used to build the templates and such.
|
|
|
|
* bjsonrpc - used for configuration management layer
|
|
|
|
* python-augeas and augeas - used for configuration management
|
|
|
|
The documentation has some dependencies too.
|
|
|
|
* *Markdown* is used to format and style docs.
|
|
|
|
* *Pandoc* converts the markdown to different formats.
|
|
|
|
* *PDFLatex* generates pdf versions of the documentation.
|
|
|
|
* *GNU Make* processes /doc/Makefile.
|
|
|
|
* *python-bootstrapform* - Render django forms for Twitter Bootstrap
|
|
|
|
## Building the Documentation
|
|
|
|
Documentation has been collected into a pdf that can be built using
|
|
`make doc`. It also gets built into smaller files and other formats,
|
|
including one suitable for install as a man page.
|