mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-28 08:03:36 +00:00
72 lines
4.0 KiB
Plaintext
72 lines
4.0 KiB
Plaintext
== FreedomBox Service (Plinth) ==
|
|
|
|
!FreedomBox Service (Plinth) is a web interface to administer the functions of the !FreedomBox.
|
|
|
|
!FreedomBox Service is [[https://www.gnu.org/philosophy/|Free Software]] under [[https://www.gnu.org/licenses/agpl.html|GNU Affero General Public License]] version 3 or (at your option) a later version.
|
|
|
|
=== Using ===
|
|
|
|
* !FreedomBox Service comes installed with all !FreedomBox images. You can [[FreedomBox/Download|download]] !FreedomBox images and run on any of the supported hardware. Then, to access !FreedomBox interface see [[FreedomBox/Manual/QuickStart|quick start]] instructions.
|
|
|
|
* If you are on a Debian box, you may install !FreedomBox Service from Debian package archive. Currently, only bullseye (stable), bookworm (testing), and sid (unstable) are supported. To install !FreedomBox Service run:
|
|
|
|
{{{
|
|
$ sudo apt-get install freedombox
|
|
}}}
|
|
|
|
* You can also get !FreedomBox Service from its [[https://salsa.debian.org/freedombox-team/freedombox/|Git repository]] and [[https://salsa.debian.org/freedombox-team/freedombox/blob/master/INSTALL.md|install from source]].
|
|
|
|
=== Screenshots ===
|
|
|
|
[[attachment:freedombox-screenshot-home.png|{{attachment:freedombox-screenshot-home.png|Home Page|width=300}}]]
|
|
[[attachment:freedombox-screenshot-apps.png|{{attachment:freedombox-screenshot-apps.png|Apps Page|width=300}}]]
|
|
[[attachment:freedombox-screenshot-system.png|{{attachment:freedombox-screenshot-system.png|System Page|width=300}}]]
|
|
|
|
[[attachment:freedombox-screenshot-tor.png|{{attachment:freedombox-screenshot-tor.png|Enabling Tor Onion Services|width=300}}]]
|
|
[[attachment:freedombox-screenshot-ttrss.png|{{attachment:freedombox-screenshot-ttrss.png|Newsfeed from anywhere|width=300}}]]
|
|
[[attachment:freedombox-screenshot-roundcube.png|{{attachment:freedombox-screenshot-roundcube.png|Email Client|width=300}}]]
|
|
|
|
[[attachment:freedombox-screenshot-manual.png|{{attachment:freedombox-screenshot-manual.png|Manual Pages|width=300}}]]
|
|
[[attachment:freedombox-screenshot-about.png|{{attachment:freedombox-screenshot-about.png|About Page|width=300}}]]
|
|
|
|
=== Support ===
|
|
|
|
You may ask for support on
|
|
|
|
* [[https://discuss.freedombox.org/|The discussion forum]]
|
|
|
|
* [[AliothList:freedombox-discuss|The mailing list]]
|
|
|
|
* [[irc://irc.debian.org/freedombox|#freedombox IRC channel]]
|
|
|
|
* [[https://matrix.to/#/#freedombox:matrix.org|FreedomBox Matrix channel]]
|
|
|
|
=== Contributing ===
|
|
|
|
We are looking for help to improve !FreedomBox Service. You can contribute to !FreedomBox Service by not just by coding but also by translating, documenting, designing, packaging and providing support.
|
|
|
|
* Instructions on how to [[FreedomBox/Contribute/Code|contribute code]] are available.
|
|
|
|
* The primary Git repository is hosted at [[https://salsa.debian.org/freedombox-team/freedombox/|FreedomBox Salsa Page]].
|
|
|
|
* Instructions for [[https://salsa.debian.org/freedombox-team/freedombox/blob/master/INSTALL.md|installing from source]] and [[https://salsa.debian.org/freedombox-team/freedombox/blob/master/HACKING.md|hacking the source]] are available.
|
|
|
|
* List of bugs, TODO items and feature requests are available on the [[https://salsa.debian.org/freedombox-team/freedombox/issues|issue tracker]].
|
|
|
|
* Before contributing to !FreedomBox Service code, you need understand [[https://www.python.org/|Python]] and [[https://www.djangoproject.com/|Django]] on top which it is built.
|
|
|
|
* You can request for development assistance on [[https://discuss.freedombox.org/|the discussion forum]], [[AliothList:freedombox-discuss|the mailing list]] or the [[irc://irc.debian.org/freedombox|#freedombox IRC channel]].
|
|
|
|
==== Debian Package ====
|
|
|
|
* !FreedomBox Service is [[DebianPkg:freedombox|packaged]] for Debian. !FreedomBox Service is a native package and packaging source code is part of the main package source code.
|
|
|
|
* Issues related to packaging are listed on [[DebianBug:freedombox|Debian BTS]].
|
|
|
|
## END_INCLUDE
|
|
|
|
<<Include(FreedomBox/Portal)>>
|
|
|
|
----
|
|
CategoryFreedomBox
|