FreedomBox/INSTALL.md
Sunil Mohan Adapa 812ed5d60d
*: Introduce make file based build, eliminate setup.py
- setuptools aims to a build library instead of being invoked by setup.py.
Launching setup tools using ./setup.py is deprecated. Launching it using
generic build tools that use pyproject.toml is recommended.

- With the new approach customizing the build is not possible to the earlier
extent. So, introduce is a simple and sufficient build system using 'make'.

Tests:

- Check the pyproject.toml using validate-pyproject tool.

- Run diffoscope on old and new packages and verify that no unexpected changes
were introduced by the build system change.

- None of the files part of .deb package have different file permissions
compared to before.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
2024-02-12 19:17:09 -05: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 --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 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.