mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-03-11 09:04:54 +00:00
168f662a17
- Since we are going to be an OpenID Provider, we need to fix the URLs that
other apps will be configured with for authentication. So change now from
/plinth to /freedombox. If done later, it will be harder since all the
configuration files for all dependent apps will need to be updated.
Tests:
- App availability checking works. Request goes to /freedombox URL
- Favicon is served properly and through /favicon.ico URL
- Redirection happens from / to /freedombox directly
- UI is available on /freedombox and on /plinth
- Manual page show /freedombox as the URL in two places
- Static files are successfully served from /freedombox URLs. URLs inside page
start with /freedombox
- backup, bepasty, calibre, config, dynamicdns, ejabberd, featherwiki, gitweb,
ikiwiki, kiwix, miniflux, names, openvpn, shadowsocks, shadowsocksserver,
sharing, shapshot, tiddlywiki, users, wireguard, jsxc, matrixsynapse, first
wizard, storage, samba, tags functional tests work. Backup/restore test for
matrixsynapse fails due to an unrelated bug (server not restarted after
restore).
- Setting the home page works:
- Having /plinth in the home page configuration works. Shows selection
correctly.
- Setting to app works. Shows selection correctly.
- Setting to user home page (sets /freedombox). Shows selection correctly.
- Setting to apache default works. Shows selection correctly.
- Changing back to FreedomBox service works. Shows selection correctly.
- Unit tests work
- Configuration page shows /freedombox in description but not /plinth
- Diagnostics show /freedombox in tests
- Roundcube URL link in email app has /freedombox
- email loads the page /.well-known/autoconfig/mail/config-v1.1.xml correctly
- email app shows /freedombox/apps/roundcube for /roundcube if roundcube is not
installed.
- networks: router configuration page shows URL starting with /freedombox.
- snapshot: Shows URL starting with /freedombox on the app page
- js licenses page uses /freedombox prefix for JSXC.
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
42 lines
1.2 KiB
Markdown
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/freedombox
|
|
|
|
If you are installing FreedomBox Service (Plinth) for development purposes, see
|
|
HACKING.md instead.
|