FreedomBox/INSTALL.md
Sunil Mohan Adapa ea362763cd
INSTALL.md: Simplify installation instructions
- Remove hard-coded list of dependencies. Maintaining a separate list here add
  development burden. This list keeps getting outdated often.

- Redirect users to QuickStart manual page for regular us.

- Remove instructions for Django < 1.11 because it is now available in buster
  and above.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2019-03-10 09:54:14 -04:00

42 lines
1.2 KiB
Markdown

# Installing FreedomBox Service (Plinth)
The following instructions are for installing FreedomBox from source code meant
for advanced users. For regular use of FreedomBox, instructions are available on
FreedomBox [Manual](https://wiki.debian.org/FreedomBox/Manual/)'s
[QuickStart](https://wiki.debian.org/FreedomBox/Manual/QuickStart) page.
1. Install FreedomBox Service (Plinth):
A Debian based system is needed to run FreedomBox. Buster release or later
is recommended. Unzip the source into a directory. Change to the directory
containing the program and run:
```
$ sudo apt build-dep .
```
```
$ sudo apt install -y $(./run --list-dependencies)
```
Install additional dependencies by picking the list from debian/control file
fields Depends: and Recommends: for the package ''freedombox''. After that
install FreedomBox Service (Plinth) itself.
```
$ sudo python3 setup.py install
```
2. Run FreedomBox Service (Plinth):
```
$ sudo plinth
```
3. Access FreedomBox UI:
UI should be accessible at http://localhost:8000/plinth
If you are installing FreedomBox Service (Plinth) for development purposes, see
HACKING.md instead.