INSTALL.md 1.19 KB
Newer Older
1
# Installing FreedomBox Service (Plinth)
James Vasile's avatar
James Vasile committed
2

3 4 5 6
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.
7

8 9 10 11 12
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:
13 14

    ```
15
    $ sudo apt build-dep .
16
    ```
17

18 19 20
    ```
    $ sudo apt install -y $(./run --list-dependencies)
    ```
21

22 23 24
    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.
25

26 27
    ```
    $ sudo python3 setup.py install
28
    ```
29

30
2.  Run FreedomBox Service (Plinth):
31

32 33 34
    ```
    $ sudo plinth
    ```
James Vasile's avatar
James Vasile committed
35

36
3.  Access FreedomBox UI:
James Vasile's avatar
James Vasile committed
37

38
    UI should be accessible at http://localhost:8000/plinth
39

40 41
If you are installing FreedomBox Service (Plinth) for development purposes, see
HACKING.md instead.