bin: Rename main binary from plinth to freedombox

- Rename manual page from plinth.1 to freedombox.1

Tests:

- Running 'make build install' and 'systemctl daemon-reload' and 'systemctl
restart plinth.service' works. Installing new app works.

- Spawning a new stable VM with the changes works. First wizard works.
Installing new app works.

- On a fresh Trixie machine, install freedombox. Then upgrade to a deb with
these changes. The service continues to work. Installing an app also works.
Binary is now /usr/bin/freedombox. /usr/bin/plinth works but it is a symlink to
/usr/bin/freedombox.

- Build a Debian package and install it on Trixie machine with freedombox
package installed. 'man plinth' works. 'man freedombox' works. Manual page
contents shows changes from 'plinth' to 'freedombox'. plinth.1.gz is a symlink
to freedombox.1.gz.

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
Sunil Mohan Adapa 2026-08-26 16:15:52 -07:00 committed by James Valleroy
parent 06595e0a55
commit a39632e9c8
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
8 changed files with 16 additions and 14 deletions

View File

@ -104,7 +104,7 @@ install:
mv $${temp}/freedombox $${temp}/freedombox*.dist-info $(DESTDIR)$${lib_dir} && \ mv $${temp}/freedombox $${temp}/freedombox*.dist-info $(DESTDIR)$${lib_dir} && \
rm -f $(DESTDIR)$${lib_dir}/freedombox*.dist-info/licenses/COPYING.md && \ rm -f $(DESTDIR)$${lib_dir}/freedombox*.dist-info/licenses/COPYING.md && \
rm -f $(DESTDIR)$${lib_dir}/freedombox*.dist-info/direct_url.json && \ rm -f $(DESTDIR)$${lib_dir}/freedombox*.dist-info/direct_url.json && \
$(INSTALL) -D -t $(BIN_DIR) bin/plinth $(INSTALL) -D -t $(BIN_DIR) bin/freedombox
$(INSTALL) -D -t $(LIB_DIR)/freedombox bin/freedombox-privileged $(INSTALL) -D -t $(LIB_DIR)/freedombox bin/freedombox-privileged
$(INSTALL) -D -t $(BIN_DIR) bin/freedombox-cmd $(INSTALL) -D -t $(BIN_DIR) bin/freedombox-cmd
$(INSTALL) -D -t $(BIN_DIR) bin/freedombox-change-password $(INSTALL) -D -t $(BIN_DIR) bin/freedombox-change-password

View File

@ -2,7 +2,7 @@
[Unit] [Unit]
Description=FreedomBox Service (Plinth) Description=FreedomBox Service (Plinth)
Documentation=man:plinth(1) Documentation=man:freedombox(1)
After=network.target After=network.target
StartLimitIntervalSec=0 StartLimitIntervalSec=0
# Uploaded files in /var/tmp/ are shared with FreedomBox privileged service. # Uploaded files in /var/tmp/ are shared with FreedomBox privileged service.
@ -10,7 +10,7 @@ JoinsNamespaceOf=freedombox-privileged.service
[Service] [Service]
Type=notify Type=notify
ExecStart=/usr/bin/plinth ExecStart=/usr/bin/freedombox
TimeoutSec=300s TimeoutSec=300s
Restart=on-failure Restart=on-failure
RestartSec=5 RestartSec=5

2
debian/freedombox.links vendored Normal file
View File

@ -0,0 +1,2 @@
usr/bin/freedombox usr/bin/plinth
usr/share/man/man1/freedombox.1.gz usr/share/man/man1/plinth.1.gz

View File

@ -1,2 +1,2 @@
./doc/freedombox-cmd.1 ./doc/freedombox-cmd.1
./doc/plinth.1 ./doc/freedombox.1

View File

@ -13,7 +13,7 @@ SCRIPTS_DIR=scripts
manual-pdfs=$(foreach lang,$(MANUAL_LANGUAGES),manual/$(lang)/freedombox-manual.pdf) manual-pdfs=$(foreach lang,$(MANUAL_LANGUAGES),manual/$(lang)/freedombox-manual.pdf)
manual-xmls=$(patsubst %.pdf,%.xml,$(manual-pdfs)) manual-xmls=$(patsubst %.pdf,%.xml,$(manual-pdfs))
OUTPUTS=$(manual-pdfs) plinth.1 freedombox-cmd.1 OUTPUTS=$(manual-pdfs) freedombox.1 freedombox-cmd.1
INSTALL_OPTS=-D --mode=644 INSTALL_OPTS=-D --mode=644
@ -33,7 +33,7 @@ endif
all: $(OUTPUTS) manual-pages all: $(OUTPUTS) manual-pages
install: all install: all
install $(INSTALL_OPTS) -t $(MAN_INSTALL_DIR)/man1 plinth.1 install $(INSTALL_OPTS) -t $(MAN_INSTALL_DIR)/man1 freedombox.1
for file in $(manual-pages-part-html) $(manual-pdfs); do \ for file in $(manual-pages-part-html) $(manual-pdfs); do \
install $(INSTALL_OPTS) -t $(INSTALL_DIR)/$$(dirname $${file}) \ install $(INSTALL_OPTS) -t $(INSTALL_DIR)/$$(dirname $${file}) \
$${file} ; \ $${file} ; \

View File

@ -5,22 +5,22 @@
--> -->
<refentry> <refentry>
<refmeta> <refmeta>
<refentrytitle><application>plinth</application></refentrytitle> <refentrytitle><application>freedombox</application></refentrytitle>
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
<refmiscinfo class="manual">FreedomBox</refmiscinfo> <refmiscinfo class="manual">FreedomBox</refmiscinfo>
<refmiscinfo class="version"> </refmiscinfo> <refmiscinfo class="version"> </refmiscinfo>
</refmeta> </refmeta>
<refnamediv> <refnamediv>
<refname><application>plinth</application></refname> <refname><application>freedombox</application></refname>
<refpurpose> <refpurpose>
a web front end for administering FreedomBox An inexpensive server at home.
</refpurpose> </refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>plinth</command> <command>freedombox</command>
<arg><option>-h, </option><option>--help</option></arg> <arg><option>-h, </option><option>--help</option></arg>
<arg><option>--server_dir</option><arg choice="req">SERVER_DIR</arg></arg> <arg><option>--server_dir</option><arg choice="req">SERVER_DIR</arg></arg>
<arg><option>--develop</option></arg> <arg><option>--develop</option></arg>
@ -182,7 +182,7 @@
<example> <example>
<title>Start FreedomBox Service with default options</title> <title>Start FreedomBox Service with default options</title>
<synopsis>$ plinth</synopsis> <synopsis>$ freedombox</synopsis>
<para> <para>
Run FreedomBox Service as guided by configuration file. Run FreedomBox Service as guided by configuration file.
</para> </para>
@ -190,7 +190,7 @@
<example> <example>
<title>Run FreedomBox Service with different URL prefix</title> <title>Run FreedomBox Service with different URL prefix</title>
<synopsis>$ plinth --server_dir='/myurl'</synopsis> <synopsis>$ freedombox --server_dir='/myurl'</synopsis>
<para> <para>
Run FreedomBox with the '/myurl' prefix. Note that Apache forwards Run FreedomBox with the '/myurl' prefix. Note that Apache forwards
requests to '/freedombox' by default, so /myurl is not accessible requests to '/freedombox' by default, so /myurl is not accessible
@ -200,7 +200,7 @@
<example> <example>
<title>Run FreedomBox Service in development mode</title> <title>Run FreedomBox Service in development mode</title>
<synopsis>$ plinth --develop</synopsis> <synopsis>$ freedombox --develop</synopsis>
<para> <para>
Run in development mode on the terminal. Enable auto-reloading and Run in development mode on the terminal. Enable auto-reloading and
more extensive debugging. more extensive debugging.

View File

@ -108,7 +108,7 @@ requires = ["setuptools"]
build-backend = "setuptools.build_meta" build-backend = "setuptools.build_meta"
[project.scripts] [project.scripts]
plinth = "freedombox.__main__:main" freedombox = "freedombox.__main__:main"
freedombox-privileged = "freedombox.privileged_daemon:main" freedombox-privileged = "freedombox.privileged_daemon:main"
freedombox-cmd = "freedombox.privileged_daemon:client_main" freedombox-cmd = "freedombox.privileged_daemon:client_main"