FreedomBox/INSTALL.md
Sunil Mohan Adapa 65ba2704a0
*: Update additional documentation/comments with new import path
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2026-08-28 07:36:20 -04:00

1.2 KiB

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's 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 --develop --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 make build install
    
  2. Run FreedomBox Service (Plinth):

    $ sudo systemctl start plinth.service
    
  3. Access FreedomBox UI:

    UI should be accessible at http://localhost:8000/freedombox

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