Verified Commit 2723822b authored by Sunil Mohan Adapa's avatar Sunil Mohan Adapa Committed by James Valleroy

Rename Plinth to FreedomBox in documentation

Signed-off-by: Sunil Mohan Adapa's avatarSunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy's avatarJames Valleroy <jvalleroy@mailbox.org>
parent 8f4811b3
# License to Copy Plinth
# License to Copy FreedomBox Service (Plinth)
Plinth is Copyright 2011, 2012, 2013, 2014, 2015, 2016, 2017 Plinth
Authors. See Git log in the source repository for a full list of
authors. It is distributed under the GNU Affero General Public License,
Version 3 or later. A copy of AGPLv3 is available [from the Free
Software Foundation](http://www.gnu.org/licenses/agpl.html).
FreedomBox Service (Plinth) is Copyright 2011, 2012, 2013, 2014, 2015, 2016,
2017, 2018 FreedomBox Authors. See Git log in the source repository for a full
list of authors. It is distributed under the GNU Affero General Public License,
Version 3 or later. A copy of AGPLv3 is available [from the Free Software
Foundation](http://www.gnu.org/licenses/agpl.html).
In addition, the documentation to this software is distributed under a
Creative Commons Attribution-ShareAlike 3.0 Unported, Version 3
......
......@@ -2,12 +2,12 @@
## Setting Up Development Environment Using Vagrant
Vagrant is a free software command line utility for managing the life
cycle of virtual machines. The FreedomBox project provides ready-made
virtual machines (VMs) for use with Vagrant. These images make setting up
an environment for Plinth development rather simple: You can edit the Plinth
source code on your host and immediately see the effects in the running VM.
The entire setup is automatic and requires about 4.5 GB of disk space.
Vagrant is a free software command line utility for managing the life cycle of
virtual machines. The FreedomBox project provides ready-made virtual machines
(VMs) for use with Vagrant. These images make setting up an environment for
FreedomBox development rather simple: You can edit the source code on your host
and immediately see the effects in the running VM. The entire setup is automatic
and requires about 4.5 GB of disk space.
1. Install Vagrant and VirtualBox:
......@@ -15,18 +15,21 @@ The entire setup is automatic and requires about 4.5 GB of disk space.
$ sudo apt-get install virtualbox vagrant
```
2. To download, setup, run, and configure a VM for Plinth development
using Vagrant, simply execute in your Plinth development folder:
2. To download, setup, run, and configure a VM for FreedomBox development using
Vagrant, simply execute in your FreedomBox Service (Plinth) development
folder:
```
$ vagrant up
```
3. To access Plinth (from host), visit https://localhost:4430/plinth/
3. To access FreedomBox web interface (from host), visit
https://localhost:4430/plinth/
4. Edit the source code in your host machine's Plinth development folder.
By default, this folder is shared within the VM, at `/vagrant/`.
To actually reflect the changes in the running VM, run on your host:
4. Edit the source code in your host machine's FreedomBox Service (Plinth)
development folder. By default, this folder is shared within the VM, at
`/vagrant/`. To actually reflect the changes in the running VM, run on your
host:
```
$ vagrant provision
......@@ -34,8 +37,8 @@ The entire setup is automatic and requires about 4.5 GB of disk space.
## Installing Dependencies
Apart from dependencies listing in INSTALL.md file, Plinth may have additional
dependencies required by modules of Plinth. To install these, run:
Apart from dependencies listing in INSTALL.md file, there may be additional
dependencies required by apps of FreedomBox. To install these, run:
```
$ sudo apt install -y $(plinth --list-dependencies)
......@@ -61,17 +64,17 @@ However, for some reason, you wish setup manually, the following tips will help:
the server as soon as a file is modified. Hence it is usually sufficient
to modify the source and refresh the browser page to see the changes.
2. Plinth also support running without installing (as much as possible).
Simply run it as:
2. FreedomBox Service (Plinth) also supports running without installing (as much
as possible). Simply run it as:
```
$ sudo ./run --debug
```
In this mode, Plinth runs in working directory without need for
installation. It uses the `plinth.conf` config file in the working
directory if no regular config file (`/etc/plinth/plinth.conf`) is found.
It creates all that data and runtime files in `data/var/*`.
In this mode, FreedomBox Service (Plinth) runs in working directory without
need for installation. It uses the `plinth.conf` config file in the working
directory if no regular config file (`/etc/plinth/plinth.conf`) is found. It
creates all that data and runtime files in `data/var/*`.
*Note:* This mode is supported only in a limited manner. The following are
the unknown issues with it:
......@@ -92,8 +95,8 @@ However, for some reason, you wish setup manually, the following tips will help:
3. Run `setup.py develop` or `setup.py install` as described above on guest
machine.
4. Access the guest machine's Plinth web UI from host after setting bridging or
NATing for guest virtual machine.
4. Access the guest machine's FreedomBox web UI from host after setting bridging
or NATing for guest virtual machine.
## Running Tests
......@@ -103,7 +106,8 @@ To run all the tests:
$ python3 setup.py test
```
To run a specific test function, test class or test module, use the `-s` option with the fully qualified name.
To run a specific test function, test class or test module, use the `-s` option
with the fully qualified name.
**Examples:**
......@@ -140,9 +144,9 @@ and which statements or branches were not executed (red).
## Building the Documentation Separately
Plinth man page is built from DocBook source in the `doc/` directory.
FreedomBox manual is downloaded from the wiki is also available there.
Both these are build during the installation process.
FreedomBox Service (Plinth) man page is built from DocBook source in the `doc/`
directory. FreedomBox manual is downloaded from the wiki is also available
there. Both these are build during the installation process.
To build the documentation separately, run:
......@@ -152,21 +156,21 @@ $ make -C doc
## Repository
Plinth is available from
FreedomBox Service (Plinth) is available from
[salsa.debian.org](https://salsa.debian.org/freedombox-team/plinth).
## Bugs & TODO
You can report bugs on Plinth's [issue
You can report bugs on FreedomBox Service's (Plinth's) [issue
tracker](https://salsa.debian.org/freedombox-team/plinth/issues).
See CONTRIBUTING.md for information how to best contribute code.
## Internationalization
To mark text for translation, Plinth uses Django's translation strings.
A module should e.g. `from django.utils.translation import ugettext as _`
and wrap user-facing text with `_()`. Use it like this:
To mark text for translation, FreedomBox Service (Plinth) uses Django's
translation strings. A module should e.g. `from django.utils.translation import
ugettext as _` and wrap user-facing text with `_()`. Use it like this:
```python
message = _('Application successfully installed and configured.')
......
# Installing Plinth
# Installing FreedomBox Service (Plinth)
1. Install the dependencies:
......@@ -41,7 +41,7 @@
xmlto
```
2. Install Plinth:
2. Install FreedomBox Service (Plinth):
Unzip the source into a directory. Change to the directory containing the
program and run:
......@@ -51,19 +51,20 @@
$ sudo apt install -y $(plinth --list-dependencies)
```
3. Run Plinth:
3. Run FreedomBox Service (Plinth):
```
$ sudo plinth
```
4. Access Plinth UI:
4. Access FreedomBox UI:
Plinth UI should be accessible at http://localhost:8000/plinth
UI should be accessible at http://localhost:8000/plinth
# Note on Django version:
Django 1.11 is required to run Plinth. You can check the version by running:
Django 1.11 is required to run FreedomBox Service (Plinth). You can check the
version by running:
```
$ django-admin --version
......
......@@ -4,10 +4,10 @@
[![Debian Testing](https://badges.debian.net/badges/debian/testing/plinth/version.svg)](https://packages.debian.org/testing/plinth)
[![Debian Stable](https://badges.debian.net/badges/debian/stable/plinth/version.svg)](https://packages.debian.org/stable/plinth)
# Plinth
# FreedomBox Service (Plinth)
[Plinth](https://wiki.debian.org/FreedomBox/Plinth) - a web front end
for administering [FreedomBox](https://freedomboxfoundation.org/)
The core functionality and web front-end of
[FreedomBox](https://freedombox.org/).
<img src="https://wiki.debian.org/FreedomBox/Plinth?action=AttachFile&do=get&target=aboutfreedombox.png" width="425px" style="margin: 5px"> <img src="https://wiki.debian.org/FreedomBox/Plinth?action=AttachFile&do=get&target=tor1.png" width="425px" style="margin: 5px">
......@@ -24,15 +24,15 @@ 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
This module, called FreedomBox Service and also know as Plinth, is the core
functionality and web interface to 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. It also allows configuration of basic system
parameters such as time zone, hostname and automatic upgrades.
You can find more information about Plinth on the
You can find more information about FreedomBox Service (Plinth) on the
[Plinth Wiki](https://wiki.debian.org/FreedomBox/Plinth) page,
the [FreedomBox Wiki](https://wiki.debian.org/FreedomBox/) and the
[FreedomBox Manual](https://wiki.debian.org/FreedomBox/Manual).
......@@ -43,13 +43,13 @@ 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:
Run FreedomBox Service (Plinth) on the local system with:
$ sudo plinth
# Contributing
See the HACKING file for contributing to Plinth.
See the HACKING file for contributing to FreedomBox Service (Plinth).
# Localization
......
Plinth translation in your language quick guide.
# FreedomBox translation in your language quick guide
## IRC
......
# Plinth HTML5 Bootstrap Theme by Sean "Diggity" O'Brien (https://github.com/seandiggity/Plinth)
# FreedomBox HTML5 Bootstrap Theme by Sean "Diggity" O'Brien (https://github.com/seandiggity/Plinth)
## Summary:
This theme is free software offered to you under the terms of the GNU Affero General Public License, Version 3 or later:
This theme is free software offered to you under the terms of the GNU Affero
General Public License, Version 3 or later:
http://www.gnu.org/licenses/agpl.html
It is based upon Twitter's Bootstrap (http://twitter.github.com/bootstrap) Bootstrap is licensed under the Apache License v2.0.
Icons from Bootstrap originate from Glyphicons Free, licensed under Creative Commons Attribution 3.0.
It is based upon Twitter's Bootstrap (http://twitter.github.com/bootstrap)
Bootstrap is licensed under the Apache License v2.0. Icons from Bootstrap
originate from Glyphicons Free, licensed under Creative Commons Attribution 3.0.
Refer to the Plinth documentation for information about editing themes and templates.
Refer to the FreedomBox documentation for information about editing themes and
templates.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment