mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-05-27 10:44:33 +00:00
75f6abac1e
- Primary purpose is to complete the App API and allow for multiple apps to be present in a module without a single clashing setup() method. Secondary objective is to get rid of SetupHelper instance simple use App instance instead. - This brings us closer to not needing to implement setup() method for some of the typical apps. - Remove default value None for old_version parameter. - A valid integer value is always passed to this call. - The value of None is undefined. - Simplifies the App API slightly. - Drop setting 'pre', 'post' values to indicate the stage of setup for the App. - Simplifies the setup methods significantly. Eliminates a class of bugs (some of them seen earlier). - The UI can show a simple 'installing...' or progress spinner instead of individual stages. - There are currently many inconsistencies where many operations are not wrapped in helper.call() calls. Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
84 lines
2.8 KiB
Python
84 lines
2.8 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""
|
|
FreedomBox app for infinoted.
|
|
"""
|
|
|
|
from django.urls import reverse_lazy
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
from plinth import actions
|
|
from plinth import app as app_module
|
|
from plinth import cfg, frontpage, menu
|
|
from plinth.daemon import Daemon
|
|
from plinth.modules.backups.components import BackupRestore
|
|
from plinth.modules.firewall.components import Firewall
|
|
from plinth.package import Packages
|
|
from plinth.utils import format_lazy
|
|
|
|
from . import manifest
|
|
|
|
_description = [
|
|
_('infinoted is a server for Gobby, a collaborative text editor.'),
|
|
format_lazy(
|
|
_('To use it, <a href="https://gobby.github.io/">download Gobby</a>, '
|
|
'desktop client and install it. Then start Gobby and select '
|
|
'"Connect to Server" and enter your {box_name}\'s domain name.'),
|
|
box_name=_(cfg.box_name)),
|
|
]
|
|
|
|
app = None
|
|
|
|
|
|
class InfinotedApp(app_module.App):
|
|
"""FreedomBox app for infinoted."""
|
|
|
|
app_id = 'infinoted'
|
|
|
|
_version = 3
|
|
|
|
def __init__(self):
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
info = app_module.Info(app_id=self.app_id, version=self._version,
|
|
name=_('infinoted'), icon_filename='infinoted',
|
|
short_description=_('Gobby Server'),
|
|
description=_description,
|
|
manual_page='Infinoted',
|
|
clients=manifest.clients)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-infinoted', info.name,
|
|
info.short_description, info.icon_filename,
|
|
'infinoted:index', parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut(
|
|
'shortcut-infinoted', info.name,
|
|
short_description=info.short_description, icon=info.icon_filename,
|
|
description=info.description, manual_page=info.manual_page,
|
|
configure_url=reverse_lazy('infinoted:index'),
|
|
clients=info.clients, login_required=False)
|
|
self.add(shortcut)
|
|
|
|
packages = Packages('packages-infinoted', ['infinoted'])
|
|
self.add(packages)
|
|
|
|
firewall = Firewall('firewall-infinoted', info.name,
|
|
ports=['infinoted-plinth'], is_external=True)
|
|
self.add(firewall)
|
|
|
|
daemon = Daemon('daemon-infinoted', 'infinoted',
|
|
listen_ports=[(6523, 'tcp4'), (6523, 'tcp6')])
|
|
self.add(daemon)
|
|
|
|
backup_restore = BackupRestore('backup-restore-infinoted',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def setup(self, old_version):
|
|
"""Install and configure the app."""
|
|
super().setup(old_version)
|
|
actions.superuser_run('infinoted', ['setup'])
|
|
self.enable()
|