mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
e5b7ed4faf
- Add tags to Info component of apps. Use only English tags for all operations. Localized tags are used for presentation to the user only. Add tags to all the apps. Conventions (English): 1. Tags describing use cases should be in kebab case. 2. Protocols in tag names should be in their canonical format. 3. Tags needn't be 100% technically correct. This can get in the way of comparing apps using a tag. Words that describe use cases that users can easily understand should be preferred over being pedantic. 4. Tags should be short, ideally not more than 2 words. Avoid conjunctions like "and", "or" in tags. 5. Avoid redundant words like "server", or "web-clients". Most apps on FreedomBox are either servers or web clients. 6. Keep your nouns singular in tags. - Use query params to filter the Apps page by tags. When all tags are removed, redirect to /apps. - Add UI elements to add and remove tag filters in the Apps page. Make the UI similar to GitLab issue tags. Since there are 40 apps, there will be at least 40 tags. Selecting a tag from a dropdown will be difficult on mobile devices. A fuzzy search is useful to find tags to add to the filter. Allow user to find the best match for the search term and highlight it visually. The user can then press Enter to select the highlighted tag. Make tag search case-insensitive. Make the dropdown menu scrollable with a fixed size. User input is debounced by 300 ms during search. - tests: Add missing mock in test_module_loader.py - Add functional tests [sunil] - 'list' can be used instead of 'List' for typing in recent Python versions. - Reserve tripe-quoted strings for docstrings. - Undo some changes in module initialization, use module_name for logging errors. - isort and yapf changes. - Encode parameters before adding them to the URL. Tests: - Tested the functionality of filtering by tag with one tag and two tags. Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net> Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org> Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
98 lines
3.5 KiB
Python
98 lines
3.5 KiB
Python
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
"""FreedomBox app to configure Shadowsocks Server."""
|
|
|
|
from django.urls import reverse_lazy
|
|
from django.utils.translation import gettext_lazy as _
|
|
|
|
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, privileged
|
|
|
|
_description = [
|
|
_('Shadowsocks is a tool for securely forwarding network requests to a'
|
|
' remote server. It consists of two parts: (1) a Shadowsocks server,'
|
|
' and (2) a Shadowsocks client with a SOCKS5 proxy.'),
|
|
_('Shadowsocks can be used to bypass Internet filtering and '
|
|
'censorship. This requires that the Shadowsocks server is in a '
|
|
'location where it can freely access the Internet, without '
|
|
'filtering.'),
|
|
format_lazy(
|
|
_('Your {box_name} can run a Shadowsocks server, that allows '
|
|
'Shadowsocks clients to connect to it. Clients\' data will be '
|
|
'encrypted and proxied through this server.'),
|
|
box_name=_(cfg.box_name)),
|
|
]
|
|
|
|
|
|
class ShadowsocksServerApp(app_module.App):
|
|
"""FreedomBox app for Shadowsocks Server."""
|
|
|
|
app_id = 'shadowsocksserver'
|
|
|
|
_version = 1
|
|
|
|
DAEMON = 'shadowsocks-libev-server@fbxserver'
|
|
|
|
def __init__(self) -> None:
|
|
"""Create components for the app."""
|
|
super().__init__()
|
|
|
|
info = app_module.Info(
|
|
app_id=self.app_id, version=self._version,
|
|
name=_('Shadowsocks Server'), icon_filename='shadowsocks',
|
|
short_description=_('Help Others Bypass Censorship'),
|
|
description=_description, manual_page='Shadowsocks',
|
|
tags=manifest.tags)
|
|
self.add(info)
|
|
|
|
menu_item = menu.Menu('menu-shadowsocks-server', info.name,
|
|
info.short_description, info.icon_filename,
|
|
'shadowsocksserver:index',
|
|
parent_url_name='apps')
|
|
self.add(menu_item)
|
|
|
|
shortcut = frontpage.Shortcut(
|
|
'shortcut-shadowsocks-server', info.name,
|
|
short_description=info.short_description, icon=info.icon_filename,
|
|
description=info.description, manual_page=info.manual_page,
|
|
configure_url=reverse_lazy('shadowsocksserver:index'),
|
|
login_required=True)
|
|
self.add(shortcut)
|
|
|
|
packages = Packages('packages-shadowsocks-server',
|
|
['shadowsocks-libev'])
|
|
self.add(packages)
|
|
|
|
firewall = Firewall('firewall-shadowsocks-server', info.name,
|
|
ports=['shadowsocks-server-freedombox'],
|
|
is_external=True)
|
|
self.add(firewall)
|
|
|
|
daemon = Daemon(
|
|
'daemon-shadowsocks-server', self.DAEMON,
|
|
listen_ports=[(8388, 'tcp4'), (8388, 'tcp6'), (8388, 'udp4'),
|
|
(8388, 'udp6')])
|
|
self.add(daemon)
|
|
|
|
backup_restore = BackupRestore('backup-restore-shadowsocks-server',
|
|
**manifest.backup)
|
|
self.add(backup_restore)
|
|
|
|
def setup(self, old_version):
|
|
"""Install and configure the app."""
|
|
super().setup(old_version)
|
|
privileged.setup()
|
|
if not old_version:
|
|
self.enable()
|
|
|
|
def uninstall(self):
|
|
"""De-configure and uninstall the app."""
|
|
super().uninstall()
|
|
privileged.uninstall()
|