mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-02-04 08:13:38 +00:00
f4f417cbb6
There are configuration items that users of syncthing can accidentally set, resulting in the UI becoming unavailable. Previously, if such a thing happened, the FreedomBox admin would have to ssh into the server and edit the xml manually or reinstall/restore the app. With this patch, it is enough to re-run the setup to make the UI accesible again. - Remove http basic authentication from the settings (gui/user and gui/password. This is unnecessary as FreedomBox already provides authentication. - Make sure these options are properly set: - 'Use HTTPS for GUI' is off - 'GUI Listen Address' is 127.0.0.1:8384 - GUI is enabled There is a forum discussion that inspired these changes: https://discuss.freedombox.org/t/solved-cant-access-syncthing-administration-panel/2137 Tests done: - Fresh install: after the setup, confirm the UI is working properly and the xml is configured with the expected values. - Make the changes to break the Syncthing UI, then re-run setup. Confirm the UI is back online. Signed-off-by: Benedek Nagy <contact@nbenedek.me> [sunil: Initialize conf_changed variable to prevent failures accessing it] Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
118 lines
3.6 KiB
Python
118 lines
3.6 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""Configure Syncthing."""
|
|
|
|
import grp
|
|
import os
|
|
import pwd
|
|
import shutil
|
|
import subprocess
|
|
import time
|
|
|
|
import augeas
|
|
|
|
from plinth import action_utils
|
|
from plinth.actions import privileged
|
|
|
|
DATA_DIR = '/var/lib/syncthing'
|
|
# legacy configuration file
|
|
CONF_FILE_LEGACY = DATA_DIR + '/.config/syncthing/config.xml'
|
|
# configuration file since Debian Trixie if '.config/syncthing' directory
|
|
# doesn't exist
|
|
CONF_FILE = DATA_DIR + '/.local/state/syncthing/config.xml'
|
|
|
|
|
|
def augeas_load(conf_file):
|
|
"""Initialize Augeas."""
|
|
aug = augeas.Augeas(flags=augeas.Augeas.NO_LOAD +
|
|
augeas.Augeas.NO_MODL_AUTOLOAD)
|
|
aug.add_transform('Xml.lns', conf_file)
|
|
aug.load()
|
|
return aug
|
|
|
|
|
|
@privileged
|
|
def setup():
|
|
"""Perform post-install actions for Syncthing."""
|
|
# Create syncthing group if needed.
|
|
try:
|
|
grp.getgrnam('syncthing')
|
|
except KeyError:
|
|
subprocess.run(['addgroup', '--system', 'syncthing'], check=True)
|
|
|
|
# Create syncthing user if needed.
|
|
try:
|
|
pwd.getpwnam('syncthing')
|
|
except KeyError:
|
|
subprocess.run([
|
|
'adduser', '--system', '--ingroup', 'syncthing', '--home',
|
|
DATA_DIR, '--gecos', 'Syncthing file synchronization server',
|
|
'syncthing'
|
|
], check=True)
|
|
|
|
if not os.path.exists(DATA_DIR):
|
|
os.makedirs(DATA_DIR, mode=0o750)
|
|
shutil.chown(DATA_DIR, user='syncthing', group='syncthing')
|
|
|
|
|
|
@privileged
|
|
def setup_config():
|
|
"""Make configuration changes."""
|
|
# wait until the configuration file is created by the syncthing daemon
|
|
conf_file_in_use = CONF_FILE
|
|
timeout = 300
|
|
while timeout > 0:
|
|
if os.path.exists(CONF_FILE_LEGACY):
|
|
conf_file_in_use = CONF_FILE_LEGACY
|
|
break
|
|
elif os.path.exists(CONF_FILE):
|
|
break
|
|
timeout = timeout - 1
|
|
time.sleep(1)
|
|
|
|
aug = augeas_load(conf_file_in_use)
|
|
|
|
# disable authentication missing notification as FreedomBox itself
|
|
# provides authentication
|
|
# also make sure no authentication is required on top of FreedomBox's
|
|
configs_to_remove = (
|
|
'options/unackedNotificationID[#text="authenticationUserAndPassword"]',
|
|
'gui/user/#text', 'gui/password/#text')
|
|
conf_changed = False
|
|
for config in configs_to_remove:
|
|
removed = bool(
|
|
aug.remove('/files' + conf_file_in_use +
|
|
f'/configuration/{config}'))
|
|
if removed:
|
|
conf_changed = True
|
|
|
|
configs = {
|
|
# disable usage reporting notification by declining reporting
|
|
# if the user has not made a choice yet
|
|
'options/urAccepted/#text': '-1',
|
|
# Set all the values that, misconfigured from the Syncthing UI,
|
|
# can make the UI inaccessible. Such misconfigurations can be
|
|
# corrected if the user re-runs the setup.
|
|
# https://discuss.freedombox.org/t/solved-cant-access-syncthing-administration-panel/2137
|
|
'gui/#attribute/tls': 'false',
|
|
'gui/#attribute/enabled': 'true',
|
|
'gui/address/#text': '127.0.0.1:8384'
|
|
}
|
|
for key, value in configs.items():
|
|
config = f'/configuration/{key}'
|
|
if aug.get('/files' + conf_file_in_use + config) != value:
|
|
aug.set('/files' + conf_file_in_use + config, value)
|
|
conf_changed = True
|
|
|
|
aug.save()
|
|
|
|
if conf_changed:
|
|
action_utils.service_try_restart('syncthing@syncthing')
|
|
|
|
|
|
@privileged
|
|
def uninstall():
|
|
"""Remove configuration directory when app is uninstalled."""
|
|
# legacy location
|
|
shutil.rmtree(DATA_DIR + '/.config', ignore_errors=True)
|
|
shutil.rmtree(DATA_DIR + '/.local', ignore_errors=True)
|