mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-02-04 08:13:38 +00:00
f1e764f2e5
- add exmachina code and test code - modify plinth.py to listen for shared secret on stdin at start (if appropriate flag is set) and try to connect to exmachina daemon - use exmachina to read and set /etc/hostname as a demo - update plinth init.d script to start exmachina and share keys - update docs with new deps and run instructions
58 lines
1.4 KiB
Plaintext
58 lines
1.4 KiB
Plaintext
# Quick Start
|
|
|
|
## Installing Plinth
|
|
|
|
Install the python-cheetah package, pandoc, python-augeas, and
|
|
bjsonrpc:
|
|
|
|
apt-get install python-cheetah pandoc python-augeas python-bjsonrpc
|
|
|
|
Install the python-simplejson
|
|
|
|
apt-get install python-simplejson
|
|
|
|
|
|
Unzip and untar the source into a directory. Change to the directory
|
|
containing the program. Run:
|
|
|
|
$ make
|
|
$ ./plinth.py
|
|
|
|
and point your web browser at `localhost:8000`. The default username is "admin"
|
|
and the default password is "secret". To actually edit the configuration of
|
|
your local/dev machine, also run:
|
|
|
|
$ sudo ./exmachina/exmachina.py -v &
|
|
|
|
## Dependencies
|
|
|
|
* cherrypy - python web engine v3+
|
|
|
|
* cheetah - Debian has python-cheetah package
|
|
|
|
* 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.
|
|
|
|
## 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.
|
|
|
|
<a name="installing_systemwide" />
|