README.md 3.41 KB
Newer Older
1
[![pipeline status](https://salsa.debian.org/freedombox-team/plinth/badges/master/pipeline.svg)](https://salsa.debian.org/freedombox-team/plinth/commits/master)
2
[![Translation status](https://hosted.weblate.org/widgets/freedombox/-/shields-badge.svg)](https://hosted.weblate.org/engage/freedombox/?utm_source=widget)
3 4 5
[![Debian Unstable](https://badges.debian.net/badges/debian/unstable/plinth/version.svg)](https://packages.debian.org/unstable/plinth)
[![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)
6

7
# FreedomBox Service (Plinth)
James Vasile's avatar
James Vasile committed
8

9 10
The core functionality and web front-end of
[FreedomBox](https://freedombox.org/).
James Vasile's avatar
James Vasile committed
11

mridulnagpal's avatar
mridulnagpal committed
12
<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">
13

mridulnagpal's avatar
mridulnagpal committed
14
<img src="https://wiki.debian.org/FreedomBox/Plinth?action=AttachFile&do=get&target=emailclient.png" width="425px" style="margin: 5px"> <img src="https://wiki.debian.org/FreedomBox/Plinth?action=AttachFile&do=get&target=newsfeed.png" width="425px" style="margin: 5px">
15

16
# Description
James Vasile's avatar
James Vasile committed
17

18
FreedomBox is a community project to develop, design and promote
Sunil Mohan Adapa's avatar
Sunil Mohan Adapa committed
19 20 21 22
personal servers running free software for private, personal
communications.  It is a networking appliance designed to allow
interfacing with the rest of the Internet under conditions of
protected privacy and data security.  It hosts applications such as
23 24 25
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.
Sunil Mohan Adapa's avatar
Sunil Mohan Adapa committed
26

27 28 29 30 31 32
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
Sunil Mohan Adapa's avatar
Sunil Mohan Adapa committed
33
parameters such as time zone, hostname and automatic upgrades.
James Vasile's avatar
James Vasile committed
34

35
You can find more information about FreedomBox Service (Plinth) on the
36 37 38 39 40
[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).

# Getting Started
Nick Daly's avatar
Nick Daly committed
41

42 43
To have a running FreedomBox, first install Debian (Buster or higher) on a clean
machine. Then run:
Sunil Mohan Adapa's avatar
Sunil Mohan Adapa committed
44

45 46 47
    ```
    $ sudo apt install freedombox
    ```
Sunil Mohan Adapa's avatar
Sunil Mohan Adapa committed
48

49 50 51
Full instructions are available on FreedomBox
[Manual](https://wiki.debian.org/FreedomBox/Manual/)'s
[QuickStart](https://wiki.debian.org/FreedomBox/Manual/QuickStart) page.
Nick Daly's avatar
Nick Daly committed
52

53 54 55
For instructions on running the service on a local machine from source code, see
INSTALL.md. For instructions on setting up for development purposes, see
HACKING.md.
Nick Daly's avatar
Nick Daly committed
56

57
# Contributing
Nick Daly's avatar
Nick Daly committed
58

59
See the [HACKING.md](https://salsa.debian.org/freedombox-team/plinth/blob/master/HACKING.md) file for contributing to FreedomBox Service (Plinth).
60 61 62

# Localization

63
[![Translation status](https://hosted.weblate.org/widgets/freedombox/-/287x66-white.png)](https://hosted.weblate.org/engage/freedombox/?utm_source=widget)