Rename Plinth to FreedomBox in module doc strings

Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: James Valleroy <jvalleroy@mailbox.org>

plinth/modules/apache/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for Apache server.
+FreedomBox app for Apache server.
 """
 
 from plinth import actions

plinth/modules/api/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for api for android app.
+FreedomBox app for api for android app.
 """
 
 version = 1

plinth/modules/api/views.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for api for android app.
+FreedomBox app for api for android app.
 """
 
 from django.http import HttpResponse

plinth/modules/avahi/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for service discovery.
+FreedomBox app for service discovery.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/bind/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure BIND server.
+FreedomBox app to configure BIND server.
 """
 
 import re

plinth/modules/cockpit/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure Cockpit.
+FreedomBox app to configure Cockpit.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/config/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for basic system configuration
+FreedomBox app for basic system configuration.
 """
 
 import socket

plinth/modules/config/views.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth views for basic system configuration
+FreedomBox views for basic system configuration.
 """
 
 import logging

plinth/modules/datetime/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure system date and time
+FreedomBox app to configure system date and time.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/datetime/views.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for configuring date and time
+FreedomBox app for configuring date and time.
 """
 
 from django.contrib import messages

plinth/modules/deluge/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure a Deluge web client.
+FreedomBox app to configure a Deluge web client.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/diagnostics/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for system diagnostics
+FreedomBox app for system diagnostics.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/diagnostics/diagnostics.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for running diagnostics
+FreedomBox app for running diagnostics.
 """
 
 import collections

plinth/modules/diaspora/__init__.py

@@ -112,7 +112,7 @@ def setup_domain_name(domain_name):
 
 
 def add_shortcut():
-    """Add shortcut to diaspora on the Plinth homepage"""
+    """Add shortcut to diaspora on the homepage."""
     if is_setup():
         frontpage.add_shortcut(
             'diaspora', name, short_description,

plinth/modules/dynamicdns/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure ez-ipupdate client
+FreedomBox app to configure ez-ipupdate client.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/ejabberd/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure ejabberd server
+FreedomBox app to configure ejabberd server.
 """
 
 from django.urls import reverse_lazy

plinth/modules/firewall/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure a firewall
+FreedomBox app to configure a firewall.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/firewall/views.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure a firewall
+FreedomBox app to configure a firewall.
 """
 
 from django.template.response import TemplateResponse

plinth/modules/first_boot/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for first boot wizard
+FreedomBox app for first boot wizard.
 """
 
 import operator

plinth/modules/help/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for help pages
+FreedomBox app for help pages.
 """
 
 from . import help  # pylint: disable-msg=W0622

plinth/modules/help/help.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Help module for Plinth.
+Help app for FreedomBox.
 """
 
 import mimetypes

plinth/modules/ikiwiki/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure ikiwiki
+FreedomBox app to configure ikiwiki.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/ikiwiki/views.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for configuring ikiwiki
+FreedomBox app for configuring ikiwiki.
 """
 
 from django.contrib import messages

plinth/modules/infinoted/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for infinoted.
+FreedomBox app for infinoted.
 """
 
 from django.urls import reverse_lazy

plinth/modules/jsxc/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure XMPP web client/jsxc
+FreedomBox app to configure XMPP web client/jsxc.
 """
 
 from django.urls import reverse_lazy

plinth/modules/letsencrypt/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for using Let's Encrypt.
+FreedomBox app for using Let's Encrypt.
 """
 
 import json

plinth/modules/letsencrypt/views.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for using Let's Encrypt.
+FreedomBox app for using Let's Encrypt.
 """
 
 import logging
@@ -101,7 +101,11 @@ def enable_renewal_management(request, domain):
 
 @require_POST
 def toggle_hooks(request, domain):
-    """Toggle pointing of certbot's hooks to Plinth, for the current domain."""
+    """Toggle pointing of certbot's hooks to FreedomBox.
+
+    For the current domain.
+
+    """
     manage_hooks_status = letsencrypt.get_manage_hooks_status()
     subcommand = 'disable' if 'enabled' in manage_hooks_status else 'enable'
 

plinth/modules/matrixsynapse/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure matrix-synapse server.
+FreedomBox app to configure matrix-synapse server.
 """
 
 import logging

plinth/modules/mediawiki/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure MediaWiki.
+FreedomBox app to configure MediaWiki.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/mediawiki/forms.py

@@ -15,7 +15,7 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for configuring MediaWiki.
+FreedomBox app for configuring MediaWiki.
 """
 
 from django import forms

plinth/modules/mediawiki/views.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for configuring MediaWiki.
+FreedomBox app for configuring MediaWiki.
 """
 
 import logging

plinth/modules/minetest/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for Minetest server.
+FreedomBox app for Minetest server.
 """
 
 import augeas

plinth/modules/monkeysphere/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for monkeysphere.
+FreedomBox app for monkeysphere.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/mumble/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure Mumble server
+FreedomBox app to configure Mumble server.
 """
 
 from django.urls import reverse_lazy

plinth/modules/names/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure name services
+FreedomBox app to configure name services.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/names/views.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for name services
+FreedomBox app for name services.
 """
 
 from django.template.response import TemplateResponse

plinth/modules/networks/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to interface with network-manager
+FreedomBox app to interface with network-manager.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/openvpn/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure OpenVPN server.
+FreedomBox app to configure OpenVPN server.
 """
 
 from django.urls import reverse_lazy

plinth/modules/openvpn/forms.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for configuring OpenVPN.
+FreedomBox app for configuring OpenVPN.
 """
 
 from django import forms

plinth/modules/openvpn/views.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for configuring OpenVPN server.
+FreedomBox app for configuring OpenVPN server.
 """
 
 from django.contrib import messages

plinth/modules/pagekite/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure PageKite
+FreedomBox app to configure PageKite.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/power/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for power controls.
+FreedomBox app for power controls.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/power/views.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for power module.
+FreedomBox app for power module.
 """
 
 from django.forms import Form

plinth/modules/privoxy/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure Privoxy.
+FreedomBox app to configure Privoxy.
 """
 
 from django.urls import reverse_lazy

plinth/modules/quassel/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for Quassel.
+FreedomBox app for Quassel.
 """
 
 from django.urls import reverse_lazy

plinth/modules/radicale/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for radicale.
+FreedomBox app for radicale.
 """
 
 import augeas

plinth/modules/repro/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for repro.
+FreedomBox app for repro.
 """
 
 from django.urls import reverse_lazy

plinth/modules/restore/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure reStore.
+FreedomBox app to configure reStore.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/roundcube/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure Roundcube.
+FreedomBox app to configure Roundcube.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/security/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for security configuration
+FreedomBox app for security configuration.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/shaarli/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure Shaarli.
+FreedomBox app to configure Shaarli.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/shadowsocks/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure Shadowsocks.
+FreedomBox app to configure Shadowsocks.
 """
 
 from django.urls import reverse_lazy

plinth/modules/shadowsocks/forms.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for configuring Shadowsocks.
+FreedomBox app for configuring Shadowsocks.
 """
 
 from django import forms

plinth/modules/shadowsocks/views.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for configuring Shadowsocks.
+FreedomBox app for configuring Shadowsocks.
 """
 
 import json

plinth/modules/snapshot/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to manage filesystem snapshots.
+FreedomBox app to manage filesystem snapshots.
 """
 
 import json

plinth/modules/ssh/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for OpenSSH server.
+FreedomBox app for OpenSSH server.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/sso/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure Single Sign On services.
+FreedomBox app to configure Single Sign On services.
 """
 
 from plinth import actions

plinth/modules/sso/forms.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Forms for the Single Sign On module of Plinth
+Forms for the Single Sign On app of FreedomBox.
 """
 
 from django.contrib.auth.forms import AuthenticationForm as DjangoAuthenticationForm

plinth/modules/sso/views.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Views for the Single Sign On module of Plinth
+Views for the Single Sign On app of FreedomBox.
 """
 
 import logging
@@ -54,8 +54,10 @@ def set_ticket_cookie(user, response):
 
 
 class SSOLoginView(LoginView):
-    """View to login to Plinth and set a auth_pubtkt cookie which will be
-    used to provide Single Sign On for some other applications
+    """View to login to FreedomBox and set a auth_pubtkt cookie.
+
+    Cookie will be used to provide Single Sign On for some other applications.
+
     """
     redirect_authenticated_user = True
     template_name = 'login.html'
@@ -101,7 +103,7 @@ def get_ip_address_from_request(request):
 
 
 class SSOLogoutView(LogoutView):
-    """View to log out of Plinth and remove the auth_pubtkt cookie"""
+    """View to log out of FreedomBox and remove the auth_pubtkt cookie."""
     template_name = 'index.html'
 
     def dispatch(self, request, *args, **kwargs):

plinth/modules/storage/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to manage storage.
+FreedomBox app to manage storage.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/syncthing/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure Syncthing.
+FreedomBox app to configure Syncthing.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/tahoe/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure Tahoe-LAFS.
+FreedomBox app to configure Tahoe-LAFS.
 """
 
 import json

plinth/modules/tor/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure Tor.
+FreedomBox app to configure Tor.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/tor/views.py

@@ -15,7 +15,7 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for configuring Tor.
+FreedomBox app for configuring Tor.
 """
 from django.contrib import messages
 from django.template.response import TemplateResponse

plinth/modules/transmission/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to configure Transmission server
+FreedomBox app to configure Transmission server.
 """
 
 import json

plinth/modules/transmission/forms.py

@@ -15,7 +15,7 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for configuring Transmission.
+FreedomBox app for configuring Transmission.
 """
 
 from django import forms

plinth/modules/transmission/views.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module for configuring Transmission Server
+FreedomBox app for configuring Transmission Server.
 """
 
 from django.contrib import messages

plinth/modules/ttrss/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module to configure Tiny Tiny RSS.
+FreedomBox app to configure Tiny Tiny RSS.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/upgrades/__init__.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for upgrades
+FreedomBox app for upgrades.
 """
 
 from django.utils.translation import ugettext_lazy as _

plinth/modules/upgrades/views.py

@@ -14,9 +14,8 @@
 # You should have received a copy of the GNU Affero General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-
 """
-Plinth module for upgrades
+FreedomBox app for upgrades.
 """
 
 from django.contrib import messages

plinth/modules/users/__init__.py

@@ -15,7 +15,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 """
-Plinth module to manage users
+FreedomBox app to manage users.
 """
 
 import subprocess