diff --git a/README.md b/README.md index d51b4f5..c908b96 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in Weblate is a libre web-based translation tool with tight version control integration. It provides two user interfaces, propagation of translations across components, quality checks and automatic linking to source files. -**Shipped version:** 5.3.1~ynh1 +**Shipped version:** 4.18.2~ynh1 **Demo:** https://hosted.weblate.org/ diff --git a/README_fr.md b/README_fr.md index 2996aed..98557db 100644 --- a/README_fr.md +++ b/README_fr.md @@ -18,7 +18,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po Weblate est un outil de traduction libre avec une intégration étroite du contrôle de version. Il fournit deux interfaces utilisateur, la propagation des traductions entre les composants, les contrôles de qualité et la liaison automatique aux fichiers source. -**Version incluse :** 5.3.1~ynh1 +**Version incluse :** 4.18.2~ynh1 **Démo :** https://hosted.weblate.org/ diff --git a/check_process b/check_process deleted file mode 100644 index b5398bd..0000000 --- a/check_process +++ /dev/null @@ -1,25 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - path="/path" - is_public=1 - admin="john" - password="1Strong-Password" - used_forge="GitLab" - forge_username="myusername" - forge_token="myoauthtoken" - ; Checks - pkg_linter=1 - setup_sub_dir=1 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=1 -;;; Options -Email= -Notification=all diff --git a/conf/celery-weblate b/conf/celery-weblate index 4624a9b..15436d5 100644 --- a/conf/celery-weblate +++ b/conf/celery-weblate @@ -2,7 +2,7 @@ CELERYD_NODES="celery notify memory backup translate" # Absolute or relative path to the 'celery' command: -CELERY_BIN="__FINALPATH__/venv/bin/celery" +CELERY_BIN="__INSTALL_DIR__/venv/bin/celery" # App instance to use # comment out this line if you don't use an app diff --git a/conf/celery-weblate.service b/conf/celery-weblate.service index 867f85f..7f6254c 100644 --- a/conf/celery-weblate.service +++ b/conf/celery-weblate.service @@ -6,8 +6,8 @@ After=network.target Type=forking User=__APP__ Group=__APP__ -EnvironmentFile=__FINALPATH__/celery-weblate -WorkingDirectory=__FINALPATH__/ +EnvironmentFile=__INSTALL_DIR__/celery-weblate +WorkingDirectory=__INSTALL_DIR__/ RuntimeDirectory=__APP__ RuntimeDirectoryPreserve=restart LogsDirectory=celery diff --git a/conf/libxxhash.src b/conf/libxxhash.src deleted file mode 100644 index 5d4f0c6..0000000 --- a/conf/libxxhash.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/Cyan4973/xxHash/archive/refs/tags/v0.8.1.tar.gz -SOURCE_SUM=3bb6b7d6f30c591dd65aaaff1c8b7a5b94d81687998ca9400082c739a690436c -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/nginx.conf b/conf/nginx.conf index e65307b..d8ae4c2 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,37 +1,32 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; # https://github.com/WeblateOrg/weblate/blob/master/weblate/examples/weblate.nginx.conf -location = __PATH__/favicon.ico { - # DATA_DIR/static/favicon.ico - alias __FINALPATH__/data/static/favicon.ico; - expires 30d; -} + location ~ ^__PATH__/favicon.ico$ { -location = __PATH__/robots.txt { - # DATA_DIR/static/robots.txt - alias __FINALPATH__/data/static/robots.txt; - expires 30d; -} + alias __INSTALL_DIR__/data/cache/static/favicon.ico; + expires 30d; + } -location __PATH__/static/ { - # DATA_DIR/static/ - alias __FINALPATH__/data/static/; - expires 30d; -} + location __PATH__/static/ { + alias __INSTALL_DIR__/data/cache/static/; + expires 30d; + } -location __PATH__/media/ { - # DATA_DIR/media/ - alias __FINALPATH__/data/media/; - expires 30d; -} + location __PATH__/media/ { + alias __INSTALL_DIR__/data/media/; + expires 30d; + } -location __PATH__/ { - # Path to source - alias __FINALPATH__/ ; + location __PATH__/ { - include uwsgi_params; - # Needed for long running operations in admin interface - uwsgi_read_timeout 3600; - uwsgi_pass unix:///var/run/__NAME__/socket; + alias __INSTALL_DIR__/; + + include uwsgi_params; + # Needed for long running operations in admin interface + uwsgi_read_timeout 3600; + # Adjust based to uwsgi configuration: + uwsgi_pass unix:///var/run/__APP__/socket; + # uwsgi_pass 127.0.0.1:8080; + # Include SSOWAT user panel. include conf.d/yunohost_panel.conf.inc; diff --git a/conf/settings.4.1.1.py b/conf/settings.4.1.1.py deleted file mode 100644 index 3174475..0000000 --- a/conf/settings.4.1.1.py +++ /dev/null @@ -1,877 +0,0 @@ -# -# Copyright © 2012 - 2020 Michal Čihař -# -# This file is part of Weblate -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . -# - - -import os -import platform -from logging.handlers import SysLogHandler - -# -# Django settings for Weblate project. -# - -DEBUG = False - -ADMINS = ( - ('__ADMIN__', '__ADMINMAIL__'), -) - -MANAGERS = ADMINS - -DATABASES = { - "default": { - # Use "postgresql" or "mysql". - "ENGINE": "django.db.backends.postgresql", - # Database name. - "NAME": "__NAME__", - # Database user. - "USER": "__NAME__", - # Database password. - "PASSWORD": "__DB_PWD__", - # Set to empty string for localhost. - "HOST": "127.0.0.1", - # Set to empty string for default. - "PORT": "", - # Customizations for databases. - "OPTIONS": { - # In case of using an older MySQL server, - # which has MyISAM as a default storage - # "init_command": "SET storage_engine=INNODB", - # Uncomment for MySQL older than 5.7: - # "init_command": "SET sql_mode='STRICT_TRANS_TABLES'", - # Set emoji capable charset for MySQL: - # "charset": "utf8mb4", - # Change connection timeout in case you get MySQL gone away error: - # "connect_timeout": 28800, - }, - } -} - -BASE_DIR = "__FINALPATH__" - -# Data directory -DATA_DIR = os.path.join(BASE_DIR, "data") - -# Local time zone for this installation. Choices can be found here: -# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name -# although not all choices may be available on all operating systems. -# In a Windows environment this must be set to your system time zone. -TIME_ZONE = "UTC" - -# Language code for this installation. All choices can be found here: -# http://www.i18nguy.com/unicode/language-identifiers.html -LANGUAGE_CODE = "en-us" - -LANGUAGES = ( - ("ar", "العربية"), - ("az", "Azərbaycan"), - ("be", "Беларуская"), - ("be@latin", "Biełaruskaja"), - ("bg", "Български"), - ("br", "Brezhoneg"), - ("ca", "Català"), - ("cs", "Čeština"), - ("da", "Dansk"), - ("de", "Deutsch"), - ("en", "English"), - ("el", "Ελληνικά"), - ("en-gb", "English (United Kingdom)"), - ("es", "Español"), - ("fi", "Suomi"), - ("fr", "Français"), - ("gl", "Galego"), - ("he", "עברית"), - ("hu", "Magyar"), - ("hr", "Hrvatski"), - ("id", "Indonesia"), - ("it", "Italiano"), - ("ja", "日本語"), - ("kab", "Taqbaylit"), - ("kk", "Қазақ тілі"), - ("ko", "한국어"), - ("nb", "Norsk bokmål"), - ("nl", "Nederlands"), - ("pl", "Polski"), - ("pt", "Português"), - ("pt-br", "Português brasileiro"), - ("ru", "Русский"), - ("sk", "Slovenčina"), - ("sl", "Slovenščina"), - ("sq", "Shqip"), - ("sr", "Српски"), - ("sv", "Svenska"), - ("tr", "Türkçe"), - ("uk", "Українська"), - ("zh-hans", "简体字"), - ("zh-hant", "正體字"), -) - -SITE_ID = 1 - -# If you set this to False, Django will make some optimizations so as not -# to load the internationalization machinery. -USE_I18N = True - -# If you set this to False, Django will not format dates, numbers and -# calendars according to the current locale. -USE_L10N = True - -# If you set this to False, Django will not use timezone-aware datetimes. -USE_TZ = True - -# URL prefix to use, please see documentation for more details -URL_PREFIX = "__PATH_URL__" - -# Absolute filesystem path to the directory that will hold user-uploaded files. -MEDIA_ROOT = os.path.join(DATA_DIR, "media") - -# URL that handles the media served from MEDIA_ROOT. Make sure to use a -# trailing slash. -MEDIA_URL = f"{URL_PREFIX}/media/" - -# Absolute path to the directory static files should be collected to. -# Don't put anything in this directory yourself; store your static files -# in apps' "static/" subdirectories and in STATICFILES_DIRS. -STATIC_ROOT = os.path.join(DATA_DIR, "static") - -# URL prefix for static files. -STATIC_URL = f"{URL_PREFIX}/static/" - -# Additional locations of static files -STATICFILES_DIRS = ( - # Put strings here, like "/home/html/static" or "C:/www/django/static". - # Always use forward slashes, even on Windows. - # Don't forget to use absolute paths, not relative paths. -) - -# List of finder classes that know how to find static files in -# various locations. -STATICFILES_FINDERS = ( - "django.contrib.staticfiles.finders.FileSystemFinder", - "django.contrib.staticfiles.finders.AppDirectoriesFinder", - "compressor.finders.CompressorFinder", -) - -# Make this unique, and don't share it with anybody. -# You can generate it using weblate/examples/generate-secret-key -SECRET_KEY = "__KEY__" # noqa - -_TEMPLATE_LOADERS = [ - "django.template.loaders.filesystem.Loader", - "django.template.loaders.app_directories.Loader", -] -if not DEBUG: - _TEMPLATE_LOADERS = [("django.template.loaders.cached.Loader", _TEMPLATE_LOADERS)] -TEMPLATES = [ - { - "BACKEND": "django.template.backends.django.DjangoTemplates", - "OPTIONS": { - "context_processors": [ - "django.contrib.auth.context_processors.auth", - "django.template.context_processors.debug", - "django.template.context_processors.i18n", - "django.template.context_processors.request", - "django.template.context_processors.csrf", - "django.contrib.messages.context_processors.messages", - "weblate.trans.context_processors.weblate_context", - ], - "loaders": _TEMPLATE_LOADERS, - }, - } -] - - -# GitHub username for sending pull requests. -# Please see the documentation for more details. -GITHUB_USERNAME = None - -# GitLab username for sending merge requests. -# Please see the documentation for more details. -GITLAB_USERNAME = None - -# Authentication configuration -AUTHENTICATION_BACKENDS = ( - "social_core.backends.email.EmailAuth", - # "social_core.backends.google.GoogleOAuth2", - # "social_core.backends.github.GithubOAuth2", - # "social_core.backends.bitbucket.BitbucketOAuth", - # "social_core.backends.suse.OpenSUSEOpenId", - # "social_core.backends.ubuntu.UbuntuOpenId", - # "social_core.backends.fedora.FedoraOpenId", - # "social_core.backends.facebook.FacebookOAuth2", - "weblate.accounts.auth.WeblateUserBackend", -) - -# Custom user model -AUTH_USER_MODEL = "weblate_auth.User" - -# Social auth backends setup -SOCIAL_AUTH_GITHUB_KEY = "" -SOCIAL_AUTH_GITHUB_SECRET = "" -SOCIAL_AUTH_GITHUB_SCOPE = ["user:email"] - -SOCIAL_AUTH_BITBUCKET_KEY = "" -SOCIAL_AUTH_BITBUCKET_SECRET = "" -SOCIAL_AUTH_BITBUCKET_VERIFIED_EMAILS_ONLY = True - -SOCIAL_AUTH_FACEBOOK_KEY = "" -SOCIAL_AUTH_FACEBOOK_SECRET = "" -SOCIAL_AUTH_FACEBOOK_SCOPE = ["email", "public_profile"] -SOCIAL_AUTH_FACEBOOK_PROFILE_EXTRA_PARAMS = {"fields": "id,name,email"} -SOCIAL_AUTH_FACEBOOK_API_VERSION = "3.1" - -SOCIAL_AUTH_GOOGLE_OAUTH2_KEY = "" -SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET = "" - -# Social auth settings -SOCIAL_AUTH_PIPELINE = ( - "social_core.pipeline.social_auth.social_details", - "social_core.pipeline.social_auth.social_uid", - "social_core.pipeline.social_auth.auth_allowed", - "social_core.pipeline.social_auth.social_user", - "weblate.accounts.pipeline.store_params", - "weblate.accounts.pipeline.verify_open", - "social_core.pipeline.user.get_username", - "weblate.accounts.pipeline.require_email", - "social_core.pipeline.mail.mail_validation", - "weblate.accounts.pipeline.revoke_mail_code", - "weblate.accounts.pipeline.ensure_valid", - "weblate.accounts.pipeline.remove_account", - "social_core.pipeline.social_auth.associate_by_email", - "weblate.accounts.pipeline.reauthenticate", - "weblate.accounts.pipeline.verify_username", - "social_core.pipeline.user.create_user", - "social_core.pipeline.social_auth.associate_user", - "social_core.pipeline.social_auth.load_extra_data", - "weblate.accounts.pipeline.cleanup_next", - "weblate.accounts.pipeline.user_full_name", - "weblate.accounts.pipeline.store_email", - "weblate.accounts.pipeline.notify_connect", - "weblate.accounts.pipeline.password_reset", -) -SOCIAL_AUTH_DISCONNECT_PIPELINE = ( - "social_core.pipeline.disconnect.allowed_to_disconnect", - "social_core.pipeline.disconnect.get_entries", - "social_core.pipeline.disconnect.revoke_tokens", - "weblate.accounts.pipeline.cycle_session", - "weblate.accounts.pipeline.adjust_primary_mail", - "weblate.accounts.pipeline.notify_disconnect", - "social_core.pipeline.disconnect.disconnect", - "weblate.accounts.pipeline.cleanup_next", -) - -# Custom authentication strategy -SOCIAL_AUTH_STRATEGY = "weblate.accounts.strategy.WeblateStrategy" - -# Raise exceptions so that we can handle them later -SOCIAL_AUTH_RAISE_EXCEPTIONS = True - -SOCIAL_AUTH_EMAIL_VALIDATION_FUNCTION = "weblate.accounts.pipeline.send_validation" -SOCIAL_AUTH_EMAIL_VALIDATION_URL = "{0}/accounts/email-sent/".format(URL_PREFIX) -SOCIAL_AUTH_LOGIN_ERROR_URL = "{0}/accounts/login/".format(URL_PREFIX) -SOCIAL_AUTH_EMAIL_FORM_URL = "{0}/accounts/email/".format(URL_PREFIX) -SOCIAL_AUTH_NEW_ASSOCIATION_REDIRECT_URL = "{0}/accounts/profile/#account".format( - URL_PREFIX -) -SOCIAL_AUTH_PROTECTED_USER_FIELDS = ("email",) -SOCIAL_AUTH_SLUGIFY_USERNAMES = True -SOCIAL_AUTH_SLUGIFY_FUNCTION = "weblate.accounts.pipeline.slugify_username" - -# Password validation configuration -AUTH_PASSWORD_VALIDATORS = [ - { - "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator" # noqa: E501, pylint: disable=line-too-long - }, - { - "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator", - "OPTIONS": {"min_length": 10}, - }, - {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"}, - {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"}, - {"NAME": "weblate.accounts.password_validation.CharsPasswordValidator"}, - {"NAME": "weblate.accounts.password_validation.PastPasswordsValidator"}, - # Optional password strength validation by django-zxcvbn-password - # { - # "NAME": "zxcvbn_password.ZXCVBNValidator", - # "OPTIONS": { - # "min_score": 3, - # "user_attributes": ("username", "email", "full_name") - # } - # }, -] - -# Allow new user registrations -REGISTRATION_OPEN = True - -# Shortcut for login required setting -REQUIRE_LOGIN = False - -# Middleware -MIDDLEWARE = [ - "weblate.middleware.ProxyMiddleware", - "django.middleware.security.SecurityMiddleware", - "django.contrib.sessions.middleware.SessionMiddleware", - "django.middleware.common.CommonMiddleware", - "django.middleware.csrf.CsrfViewMiddleware", - "weblate.accounts.middleware.AuthenticationMiddleware", - "django.contrib.messages.middleware.MessageMiddleware", - "django.middleware.clickjacking.XFrameOptionsMiddleware", - "social_django.middleware.SocialAuthExceptionMiddleware", - "weblate.accounts.middleware.RequireLoginMiddleware", - "weblate.api.middleware.ThrottlingMiddleware", - "weblate.middleware.SecurityMiddleware", -] - -ROOT_URLCONF = "weblate.urls" - -# Django and Weblate apps -INSTALLED_APPS = [ - # Weblate apps on top to override Django locales and templates - "weblate.addons", - "weblate.auth", - "weblate.checks", - "weblate.formats", - "weblate.glossary", - "weblate.machinery", - "weblate.trans", - "weblate.lang", - "weblate.langdata", - "weblate.memory", - "weblate.screenshots", - "weblate.fonts", - "weblate.accounts", - "weblate.utils", - "weblate.vcs", - "weblate.wladmin", - "weblate", - # Optional: Git exporter - "weblate.gitexport", - # Standard Django modules - "django.contrib.auth", - "django.contrib.contenttypes", - "django.contrib.sessions", - "django.contrib.sites", - "django.contrib.messages", - "django.contrib.staticfiles", - "django.contrib.admin.apps.SimpleAdminConfig", - "django.contrib.admindocs", - "django.contrib.sitemaps", - "django.contrib.humanize", - # Third party Django modules - "social_django", - "crispy_forms", - "compressor", - "rest_framework", - "rest_framework.authtoken", - "django_filters", -] - -# Custom exception reporter to include some details -DEFAULT_EXCEPTION_REPORTER_FILTER = "weblate.trans.debug.WeblateExceptionReporterFilter" - -# Default logging of Weblate messages -# - to syslog in production (if available) -# - otherwise to console -# - you can also choose "logfile" to log into separate file -# after configuring it below - -# Detect if we can connect to syslog -HAVE_SYSLOG = False -if platform.system() != "Windows": - try: - handler = SysLogHandler(address="/dev/log", facility=SysLogHandler.LOG_LOCAL2) - handler.close() - HAVE_SYSLOG = True - except IOError: - HAVE_SYSLOG = False - -if DEBUG or not HAVE_SYSLOG: - DEFAULT_LOG = "console" -else: - DEFAULT_LOG = "syslog" - -# A sample logging configuration. The only tangible logging -# performed by this configuration is to send an email to -# the site admins on every HTTP 500 error when DEBUG=False. -# See http://docs.djangoproject.com/en/stable/topics/logging for -# more details on how to customize your logging configuration. -LOGGING = { - "version": 1, - "disable_existing_loggers": True, - "filters": {"require_debug_false": {"()": "django.utils.log.RequireDebugFalse"}}, - "formatters": { - "syslog": {"format": "weblate[%(process)d]: %(levelname)s %(message)s"}, - "simple": {"format": "%(levelname)s %(message)s"}, - "logfile": {"format": "%(asctime)s %(levelname)s %(message)s"}, - "django.server": { - "()": "django.utils.log.ServerFormatter", - "format": "[%(server_time)s] %(message)s", - }, - }, - "handlers": { - "mail_admins": { - "level": "ERROR", - "filters": ["require_debug_false"], - "class": "django.utils.log.AdminEmailHandler", - "include_html": True, - }, - "console": { - "level": "DEBUG", - "class": "logging.StreamHandler", - "formatter": "simple", - }, - "django.server": { - "level": "INFO", - "class": "logging.StreamHandler", - "formatter": "django.server", - }, - "syslog": { - "level": "DEBUG", - "class": "logging.handlers.SysLogHandler", - "formatter": "syslog", - "address": "/dev/log", - "facility": SysLogHandler.LOG_LOCAL2, - }, - # Logging to a file - # "logfile": { - # "level":"DEBUG", - # "class":"logging.handlers.RotatingFileHandler", - # "filename": "/var/log/weblate/weblate.log", - # "maxBytes": 100000, - # "backupCount": 3, - # "formatter": "logfile", - # }, - }, - "loggers": { - "django.request": { - "handlers": ["mail_admins", DEFAULT_LOG], - "level": "ERROR", - "propagate": True, - }, - "django.server": { - "handlers": ["django.server"], - "level": "INFO", - "propagate": False, - }, - # Logging database queries - # "django.db.backends": { - # "handlers": [DEFAULT_LOG], - # "level": "DEBUG", - # }, - "weblate": {"handlers": [DEFAULT_LOG], "level": "DEBUG"}, - # Logging search operations - "weblate.search": {"handlers": [DEFAULT_LOG], "level": "INFO"}, - # Logging VCS operations - "weblate.vcs": {"handlers": [DEFAULT_LOG], "level": "WARNING"}, - # Python Social Auth - "social": {"handlers": [DEFAULT_LOG], "level": "DEBUG" if DEBUG else "WARNING"}, - # Django Authentication Using LDAP - "django_auth_ldap": { - "level": "DEBUG" if DEBUG else "WARNING", - "handlers": [DEFAULT_LOG], - }, - }, -} - -# Remove syslog setup if it's not present -if not HAVE_SYSLOG: - del LOGGING["handlers"]["syslog"] - -# List of machine translations -# MT_SERVICES = ( -# "weblate.machinery.apertium.ApertiumAPYTranslation", -# "weblate.machinery.baidu.BaiduTranslation", -# "weblate.machinery.deepl.DeepLTranslation", -# "weblate.machinery.glosbe.GlosbeTranslation", -# "weblate.machinery.google.GoogleTranslation", -# "weblate.machinery.googlev3.GoogleV3Translation", -# "weblate.machinery.microsoft.MicrosoftCognitiveTranslation", -# "weblate.machinery.microsoftterminology.MicrosoftTerminologyService", -# "weblate.machinery.mymemory.MyMemoryTranslation", -# "weblate.machinery.netease.NeteaseSightTranslation", -# "weblate.machinery.tmserver.AmagamaTranslation", -# "weblate.machinery.tmserver.TMServerTranslation", -# "weblate.machinery.yandex.YandexTranslation", -# "weblate.machinery.saptranslationhub.SAPTranslationHub", -# "weblate.machinery.youdao.YoudaoTranslation", -# "weblate.machinery.weblatetm.WeblateTranslation", -# "weblate.memory.machine.WeblateMemory", -# ) - -# Machine translation API keys - -# URL of the Apertium APy server -MT_APERTIUM_APY = None - -# DeepL API key -MT_DEEPL_KEY = None - -# Microsoft Cognitive Services Translator API, register at -# https://portal.azure.com/ -MT_MICROSOFT_COGNITIVE_KEY = None -MT_MICROSOFT_REGION = None - -# MyMemory identification email, see -# https://mymemory.translated.net/doc/spec.php -MT_MYMEMORY_EMAIL = None - -# Optional MyMemory credentials to access private translation memory -MT_MYMEMORY_USER = None -MT_MYMEMORY_KEY = None - -# Google API key for Google Translate API v2 -MT_GOOGLE_KEY = None - -# Google Translate API3 credentials and project id -MT_GOOGLE_CREDENTIALS = None -MT_GOOGLE_PROJECT = None - -# Baidu app key and secret -MT_BAIDU_ID = None -MT_BAIDU_SECRET = None - -# Youdao Zhiyun app key and secret -MT_YOUDAO_ID = None -MT_YOUDAO_SECRET = None - -# Netease Sight (Jianwai) app key and secret -MT_NETEASE_KEY = None -MT_NETEASE_SECRET = None - -# API key for Yandex Translate API -MT_YANDEX_KEY = None - -# tmserver URL -MT_TMSERVER = None - -# SAP Translation Hub -MT_SAP_BASE_URL = None -MT_SAP_SANDBOX_APIKEY = None -MT_SAP_USERNAME = None -MT_SAP_PASSWORD = None -MT_SAP_USE_MT = True - -# Title of site to use -SITE_TITLE = "Weblate" - -# Whether site uses https -ENABLE_HTTPS = False - -# Use HTTPS when creating redirect URLs for social authentication, see -# documentation for more details: -# https://python-social-auth-docs.readthedocs.io/en/latest/configuration/settings.html#processing-redirects-and-urlopen -SOCIAL_AUTH_REDIRECT_IS_HTTPS = ENABLE_HTTPS - -# Make CSRF cookie HttpOnly, see documentation for more details: -# https://docs.djangoproject.com/en/1.11/ref/settings/#csrf-cookie-httponly -CSRF_COOKIE_HTTPONLY = True -CSRF_COOKIE_SECURE = ENABLE_HTTPS -# Store CSRF token in session -CSRF_USE_SESSIONS = True -# Customize CSRF failure view -CSRF_FAILURE_VIEW = "weblate.trans.views.error.csrf_failure" -SESSION_COOKIE_SECURE = ENABLE_HTTPS -SESSION_COOKIE_HTTPONLY = True -# SSL redirect -SECURE_SSL_REDIRECT = ENABLE_HTTPS -# Sent referrrer only for same origin links -SECURE_REFERRER_POLICY = "same-origin" -# SSL redirect URL exemption list -SECURE_REDIRECT_EXEMPT = (r"healthz/$",) # Allowing HTTP access to health check -# Session cookie age (in seconds) -SESSION_COOKIE_AGE = 1209600 -# Increase allowed upload size -DATA_UPLOAD_MAX_MEMORY_SIZE = 50000000 - -# Apply session coookie settings to language cookie as ewll -LANGUAGE_COOKIE_SECURE = SESSION_COOKIE_SECURE -LANGUAGE_COOKIE_HTTPONLY = SESSION_COOKIE_HTTPONLY -LANGUAGE_COOKIE_AGE = SESSION_COOKIE_AGE * 10 - -# Some security headers -SECURE_BROWSER_XSS_FILTER = True -X_FRAME_OPTIONS = "DENY" -SECURE_CONTENT_TYPE_NOSNIFF = True - -# Optionally enable HSTS -SECURE_HSTS_SECONDS = 31536000 if ENABLE_HTTPS else 0 -SECURE_HSTS_PRELOAD = ENABLE_HTTPS -SECURE_HSTS_INCLUDE_SUBDOMAINS = False - -# URL of login -LOGIN_URL = "{0}/accounts/login/".format(URL_PREFIX) - -# URL of logout -LOGOUT_URL = "{0}/accounts/logout/".format(URL_PREFIX) - -# Default location for login -LOGIN_REDIRECT_URL = "{0}/".format(URL_PREFIX) - -# Anonymous user name -ANONYMOUS_USER_NAME = "anonymous" - -# Reverse proxy settings -IP_PROXY_HEADER = "HTTP_X_FORWARDED_FOR" -IP_BEHIND_REVERSE_PROXY = False -IP_PROXY_OFFSET = 0 - -# Sending HTML in mails -EMAIL_SEND_HTML = True - -# Subject of emails includes site title -EMAIL_SUBJECT_PREFIX = "[{0}] ".format(SITE_TITLE) - -# Enable remote hooks -ENABLE_HOOKS = True - -# Number of nearby messages to show in each direction -NEARBY_MESSAGES = 5 - -# By default the length of a given translation is limited to the length of -# the source string * 10 characters. Set this option to False to allow longer -# translations (up to 10.000 characters) -LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH = True - -# Use simple language codes for default language/country combinations -SIMPLIFY_LANGUAGES = True - -# Render forms using bootstrap -CRISPY_TEMPLATE_PACK = "bootstrap3" - -# List of quality checks -# CHECK_LIST = ( -# "weblate.checks.same.SameCheck", -# "weblate.checks.chars.BeginNewlineCheck", -# "weblate.checks.chars.EndNewlineCheck", -# "weblate.checks.chars.BeginSpaceCheck", -# "weblate.checks.chars.EndSpaceCheck", -# "weblate.checks.chars.DoubleSpaceCheck", -# "weblate.checks.chars.EndStopCheck", -# "weblate.checks.chars.EndColonCheck", -# "weblate.checks.chars.EndQuestionCheck", -# "weblate.checks.chars.EndExclamationCheck", -# "weblate.checks.chars.EndEllipsisCheck", -# "weblate.checks.chars.EndSemicolonCheck", -# "weblate.checks.chars.MaxLengthCheck", -# "weblate.checks.chars.KashidaCheck", -# "weblate.checks.chars.PuctuationSpacingCheck", -# "weblate.checks.format.PythonFormatCheck", -# "weblate.checks.format.PythonBraceFormatCheck", -# "weblate.checks.format.PHPFormatCheck", -# "weblate.checks.format.CFormatCheck", -# "weblate.checks.format.PerlFormatCheck", -# "weblate.checks.format.JavaScriptFormatCheck", -# "weblate.checks.format.CSharpFormatCheck", -# "weblate.checks.format.JavaFormatCheck", -# "weblate.checks.format.JavaMessageFormatCheck", -# "weblate.checks.format.PercentPlaceholdersCheck", -# "weblate.checks.format.I18NextInterpolationCheck", -# "weblate.checks.angularjs.AngularJSInterpolationCheck", -# "weblate.checks.qt.QtFormatCheck", -# "weblate.checks.qt.QtPluralCheck", -# "weblate.checks.ruby.RubyFormatCheck", -# "weblate.checks.consistency.PluralsCheck", -# "weblate.checks.consistency.SamePluralsCheck", -# "weblate.checks.consistency.ConsistencyCheck", -# "weblate.checks.consistency.TranslatedCheck", -# "weblate.checks.chars.EscapedNewlineCountingCheck", -# "weblate.checks.chars.NewLineCountCheck", -# "weblate.checks.markup.BBCodeCheck", -# "weblate.checks.chars.ZeroWidthSpaceCheck", -# "weblate.checks.render.MaxSizeCheck", -# "weblate.checks.markup.XMLValidityCheck", -# "weblate.checks.markup.XMLTagsCheck", -# "weblate.checks.markup.MarkdownRefLinkCheck", -# "weblate.checks.markup.MarkdownLinkCheck", -# "weblate.checks.markup.MarkdownSyntaxCheck", -# "weblate.checks.markup.URLCheck", -# "weblate.checks.markup.SafeHTMLCheck", -# "weblate.checks.placeholders.PlaceholderCheck", -# "weblate.checks.placeholders.RegexCheck", -# "weblate.checks.duplicate.DuplicateCheck", -# "weblate.checks.source.OptionalPluralCheck", -# "weblate.checks.source.EllipsisCheck", -# "weblate.checks.source.MultipleFailingCheck", -# "weblate.checks.source.LongUntranslatedCheck", -# "weblate.checks.format.MultipleUnnamedFormatsCheck", -# ) - -# List of automatic fixups -# AUTOFIX_LIST = ( -# "weblate.trans.autofixes.whitespace.SameBookendingWhitespace", -# "weblate.trans.autofixes.chars.ReplaceTrailingDotsWithEllipsis", -# "weblate.trans.autofixes.chars.RemoveZeroSpace", -# "weblate.trans.autofixes.chars.RemoveControlChars", -# ) - -# List of enabled addons -# WEBLATE_ADDONS = ( -# "weblate.addons.gettext.GenerateMoAddon", -# "weblate.addons.gettext.UpdateLinguasAddon", -# "weblate.addons.gettext.UpdateConfigureAddon", -# "weblate.addons.gettext.MsgmergeAddon", -# "weblate.addons.gettext.GettextCustomizeAddon", -# "weblate.addons.gettext.GettextAuthorComments", -# "weblate.addons.cleanup.CleanupAddon", -# "weblate.addons.consistency.LangaugeConsistencyAddon", -# "weblate.addons.discovery.DiscoveryAddon", -# "weblate.addons.flags.SourceEditAddon", -# "weblate.addons.flags.TargetEditAddon", -# "weblate.addons.flags.SameEditAddon", -# "weblate.addons.flags.BulkEditAddon", -# "weblate.addons.generate.GenerateFileAddon", -# "weblate.addons.json.JSONCustomizeAddon", -# "weblate.addons.properties.PropertiesSortAddon", -# "weblate.addons.git.GitSquashAddon", -# "weblate.addons.removal.RemoveComments", -# "weblate.addons.removal.RemoveSuggestions", -# "weblate.addons.resx.ResxUpdateAddon", -# "weblate.addons.yaml.YAMLCustomizeAddon", -# "weblate.addons.autotranslate.AutoTranslateAddon", -# ) - -# E-mail address that error messages come from. -SERVER_EMAIL = "noreply@__DOMAIN__" - -# Default email address to use for various automated correspondence from -# the site managers. Used for registration emails. -DEFAULT_FROM_EMAIL = "noreply@__ADMINMAIL__" - -# List of URLs your site is supposed to serve -ALLOWED_HOSTS = ["__DOMAIN__"] - -# Configuration for caching -CACHES = { - "default": { - "BACKEND": "django_redis.cache.RedisCache", - "LOCATION": "redis://127.0.0.1:6379/__REDIS_DB__", - # If redis is running on same host as Weblate, you might - # want to use unix sockets instead: - # "LOCATION": "unix:///var/run/redis/redis.sock?db=1", - "OPTIONS": { - "CLIENT_CLASS": "django_redis.client.DefaultClient", - "PARSER_CLASS": "redis.connection.HiredisParser", - "PASSWORD": None, - "CONNECTION_POOL_KWARGS": {}, - }, - "KEY_PREFIX": "weblate", - }, - "avatar": { - "BACKEND": "django.core.cache.backends.filebased.FileBasedCache", - "LOCATION": os.path.join(DATA_DIR, "avatar-cache"), - "TIMEOUT": 86400, - "OPTIONS": {"MAX_ENTRIES": 1000}, - }, -} - -# Store sessions in cache -SESSION_ENGINE = "django.contrib.sessions.backends.cache" -# Store messages in session -MESSAGE_STORAGE = "django.contrib.messages.storage.session.SessionStorage" - -# REST framework settings for API -REST_FRAMEWORK = { - # Use Django's standard `django.contrib.auth` permissions, - # or allow read-only access for unauthenticated users. - "DEFAULT_PERMISSION_CLASSES": [ - # Require authentication for login required sites - "rest_framework.permissions.IsAuthenticated" - if REQUIRE_LOGIN - else "rest_framework.permissions.IsAuthenticatedOrReadOnly" - ], - "DEFAULT_AUTHENTICATION_CLASSES": ( - "rest_framework.authentication.TokenAuthentication", - "weblate.api.authentication.BearerAuthentication", - "rest_framework.authentication.SessionAuthentication", - ), - "DEFAULT_THROTTLE_CLASSES": ( - "weblate.api.throttling.UserRateThrottle", - "weblate.api.throttling.AnonRateThrottle", - ), - "DEFAULT_THROTTLE_RATES": {"anon": "100/day", "user": "5000/hour"}, - "DEFAULT_PAGINATION_CLASS": ("rest_framework.pagination.PageNumberPagination"), - "PAGE_SIZE": 20, - "VIEW_DESCRIPTION_FUNCTION": "weblate.api.views.get_view_description", - "UNAUTHENTICATED_USER": "weblate.auth.models.get_anonymous", -} - -# Require login for all URLs -if REQUIRE_LOGIN: - LOGIN_REQUIRED_URLS = (r"/(.*)$",) - -# In such case you will want to include some of the exceptions -# LOGIN_REQUIRED_URLS_EXCEPTIONS = ( -# rf"{URL_PREFIX}/accounts/(.*)$", # Required for login -# rf"{URL_PREFIX}/admin/login/(.*)$", # Required for admin login -# rf"{URL_PREFIX}/static/(.*)$", # Required for development mode -# rf"{URL_PREFIX}/widgets/(.*)$", # Allowing public access to widgets -# rf"{URL_PREFIX}/data/(.*)$", # Allowing public access to data exports -# rf"{URL_PREFIX}/hooks/(.*)$", # Allowing public access to notification hooks -# rf"{URL_PREFIX}/healthz/$", # Allowing public access to health check -# rf"{URL_PREFIX}/api/(.*)$", # Allowing access to API -# rf"{URL_PREFIX}/js/i18n/$", # JavaScript localization -# rf"{URL_PREFIX}/contact/$", # Optional for contact form -# rf"{URL_PREFIX}/legal/(.*)$", # Optional for legal app -# ) - -# Silence some of the Django system checks -SILENCED_SYSTEM_CHECKS = [ - # We have modified django.contrib.auth.middleware.AuthenticationMiddleware - # as weblate.accounts.middleware.AuthenticationMiddleware - "admin.E408" -] - -# Celery worker configuration for testing -# CELERY_TASK_ALWAYS_EAGER = True -# CELERY_BROKER_URL = "memory://" -# CELERY_TASK_EAGER_PROPAGATES = True -# Celery worker configuration for production -CELERY_TASK_ALWAYS_EAGER = False -CELERY_BROKER_URL = "redis://127.0.0.1:6379" -CELERY_RESULT_BACKEND = CELERY_BROKER_URL - -# Celery settings, it is not recommended to change these -CELERY_WORKER_MAX_MEMORY_PER_CHILD = 200000 -CELERY_BEAT_SCHEDULE_FILENAME = os.path.join(DATA_DIR, "celery", "beat-schedule") -CELERY_TASK_ROUTES = { - "weblate.trans.tasks.auto_translate": {"queue": "translate"}, - "weblate.memory.tasks.*": {"queue": "memory"}, - "weblate.accounts.tasks.notify_*": {"queue": "notify"}, - "weblate.accounts.tasks.send_mails": {"queue": "notify"}, - "weblate.utils.tasks.settings_backup": {"queue": "backup"}, - "weblate.utils.tasks.database_backup": {"queue": "backup"}, - "weblate.wladmin.tasks.backup": {"queue": "backup"}, - "weblate.wladmin.tasks.backup_service": {"queue": "backup"}, -} - -# Enable plain database backups -DATABASE_BACKUP = "plain" - -# Enable auto updating -AUTO_UPDATE = False - -# PGP commits signing -WEBLATE_GPG_IDENTITY = None - -# Third party services integration -MATOMO_SITE_ID = None -MATOMO_URL = None -GOOGLE_ANALYTICS_ID = None -SENTRY_DSN = None -AKISMET_API_KEY = None \ No newline at end of file diff --git a/conf/settings.py b/conf/settings.py index c91a08e..d274ee9 100644 --- a/conf/settings.py +++ b/conf/settings.py @@ -5,7 +5,7 @@ ################################################################################ # Please do not modify this file, it will be reset at the next update. -# You can edit the file __FINALPATH__/local_settings.py and add/modify the settings you need. +# You can edit the file __INSTALL_DIR__/local_settings.py and add/modify the settings you need. # The parameters you add in local_settings.py will overwrite these, # but you can use the options and documentation in this file to find out what can be done. @@ -83,7 +83,7 @@ DATABASES = { # Data directory, you can use following for the development purposes: # os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), "data") -DATA_DIR = "__FINALPATH__/data" +DATA_DIR = "__INSTALL_DIR__/data" CACHE_DIR = f"{DATA_DIR}/cache" # Local time zone for this installation. Choices can be found here: @@ -158,7 +158,8 @@ USE_TZ = True DEFAULT_AUTO_FIELD = "django.db.models.AutoField" # URL prefix to use, please see documentation for more details -URL_PREFIX = "__PATH_URL__" +# WARNING: this must be without trailing slash (this is why we set __PATH_NO_SLASH__ (cf. loaded settings in install and upgrade)) +URL_PREFIX = "__PATH_NO_SLASH__" # Absolute filesystem path to the directory that will hold user-uploaded files. MEDIA_ROOT = os.path.join(DATA_DIR, "media") @@ -225,6 +226,10 @@ GITHUB_CREDENTIALS = { # Please see the documentation for more details. AZURE_DEVOPS_CREDENTIALS = {} +# Azure DevOps username and token for sending pull requests. +# Please see the documentation for more details. +AZURE_DEVOPS_CREDENTIALS = {} + # GitLab username and token for sending merge requests. # Please see the documentation for more details. GITLAB_CREDENTIALS = { @@ -757,7 +762,7 @@ CRISPY_TEMPLATE_PACK = "bootstrap3" # ) # E-mail address that error messages come from. -SERVER_EMAIL = "noreply@__DOMAIN__" +SERVER_EMAIL = "__APP__@__DOMAIN__" # Default email address to use for various automated correspondence from # the site managers. Used for registration emails. @@ -826,7 +831,7 @@ REST_FRAMEWORK = { FONTS_CDN_URL = None # Django compressor offline mode -COMPRESS_OFFLINE = False +COMPRESS_OFFLINE = True COMPRESS_OFFLINE_CONTEXT = "weblate.utils.compress.offline_context" COMPRESS_CSS_HASHING_METHOD = "content" @@ -863,7 +868,7 @@ SILENCED_SYSTEM_CHECKS = [ # CELERY_TASK_EAGER_PROPAGATES = True # Celery worker configuration for production CELERY_TASK_ALWAYS_EAGER = False -CELERY_BROKER_URL = "redis://127.0.0.1:6379" +CELERY_BROKER_URL = "redis://127.0.0.1:6379/__REDIS_DB__" CELERY_RESULT_BACKEND = CELERY_BROKER_URL # Celery settings, it is not recommended to change these @@ -899,4 +904,10 @@ MATOMO_URL = None GOOGLE_ANALYTICS_ID = None SENTRY_DSN = None SENTRY_ENVIRONMENT = SITE_DOMAIN -AKISMET_API_KEY = None \ No newline at end of file +AKISMET_API_KEY = None + +# Yunohost hack so users can define a new conf, and we can just replace the conf +try: + from .local_settings import * +except ImportError: + pass diff --git a/conf/uwsgi.ini b/conf/uwsgi.ini index bbabbad..23259ec 100644 --- a/conf/uwsgi.ini +++ b/conf/uwsgi.ini @@ -5,14 +5,15 @@ protocol = uwsgi socket = /var/run/__APP__/socket # http://uwsgi-docs.readthedocs.io/en/latest/Nginx.html#hosting-multiple-apps-in-the-same-process-aka-managing-script-name-and-path-info -mount = __PATH_URL__=__FINALPATH__/venv/lib/__WEBLATE_PYPATH__/site-packages/weblate/wsgi.py +mount = __PATH__=__INSTALL_DIR__/venv/lib/__WEBLATE_PYPATH__/site-packages/weblate/wsgi.py + # Add path to Weblate checkout if you did not install # Weblate by pip # python-path = /path/to/weblate # In case you're using virtualenv uncomment this: -virtualenv = __FINALPATH__/venv +virtualenv = __INSTALL_DIR__/venv # Needed for OAuth/OpenID buffer-size = 8192 diff --git a/conf/weblate.service b/conf/weblate.service index 6ffe8df..bf30598 100644 --- a/conf/weblate.service +++ b/conf/weblate.service @@ -22,7 +22,7 @@ ExecStart=/usr/bin/uwsgi \ Restart=on-failure KillSignal=SIGQUIT Type=notify -StandardError=syslog +StandardError=inherit NotifyAccess=all [Install] diff --git a/doc/DISCLAIMER.md b/doc/ADMIN.md similarity index 91% rename from doc/DISCLAIMER.md rename to doc/ADMIN.md index fa73e74..b45a318 100644 --- a/doc/DISCLAIMER.md +++ b/doc/ADMIN.md @@ -8,7 +8,7 @@ This user will only be used to open the pull-request, each translation keep his ## Settings and upgrades Almost everything related to Weblate's configuration is handled in a `settings.py` file. -You can edit the file `$final_path/local_settings.py` to enable or disable features. +You can edit the file `__INSTALL_DIR__/local_settings.py` to enable or disable features. # Miscellaneous diff --git a/doc/DISCLAIMER_fr.md b/doc/ADMIN_fr.md similarity index 90% rename from doc/DISCLAIMER_fr.md rename to doc/ADMIN_fr.md index ffab432..15cd506 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/ADMIN_fr.md @@ -8,10 +8,10 @@ Cet utilisateur ne sera utilisé que pour ouvrir la pull-request, chaque traduct ## Paramètres et mises à niveau Presque tout ce qui concerne la configuration de Weblate est géré dans un fichier `settings.py`. -Vous pouvez éditer le fichier `$final_path/local_settings.py` pour activer ou désactiver des fonctionnalités. +Vous pouvez éditer le fichier `__INSTALL_DIR__/local_settings.py` pour activer ou désactiver des fonctionnalités. # Divers ## Connexion LDAP -Cela ne fonctionne pas encore, mais bien que [cela semble faisable](https://docs.weblate.org/en/latest/admin/auth.html?highlight=LDAP#ldap-authentication), je ne suis pas sûr que ce soit le cas une bonne idée de connecter ce genre d'outils à votre LDAP. \ No newline at end of file +Cela ne fonctionne pas encore, mais bien que [cela semble faisable](https://docs.weblate.org/en/latest/admin/auth.html?highlight=LDAP#ldap-authentication), je ne suis pas sûr que ce soit le cas une bonne idée de connecter ce genre d'outils à votre LDAP. diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 8f50f4e..0000000 --- a/manifest.json +++ /dev/null @@ -1,95 +0,0 @@ -{ - "name": "Weblate", - "id": "weblate", - "packaging_format": 1, - "description": { - "en": "Translation platform using Git and Python", - "fr": "Plateforme de traduction utilisant Git et Python" - }, - "version": "5.3.1~ynh1", - "url": "https://weblate.org", - "upstream": { - "license": "AGPL-3.0", - "website": "https://weblate.org", - "demo": "https://hosted.weblate.org/", - "admindoc": "https://docs.weblate.org/", - "userdoc": "https://docs.weblate.org/", - "code": "https://github.com/WeblateOrg/weblate" - }, - "license": "AGPL-3.0", - "maintainer": { - "name": "YunoHost Contributors", - "email": "apps@yunohost.org" - }, - "previous_maintainers": [ - { - "name": "Jean-Baptiste Holcroft", - "email": "jean-baptiste@holcroft.fr" - } - ], - "requirements": { - "yunohost": ">= 11.2" - }, - "multi_instance": true, - "services": [ - "nginx" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "path", - "type": "path", - "example": "/weblate", - "default": "/weblate" - }, - { - "name": "is_public", - "type": "boolean", - "default": false - }, - { - "name": "admin", - "type": "user" - }, - { - "name": "password", - "type": "password" - }, - { - "name": "used_forge", - "type": "select", - "ask": { - "en": "Choose the forge you use", - "fr": "Choisissez la forge que vous utilisez" - }, - "choices": [ - "GitHub", - "GitLab" - ], - "default": "GitHub" - }, - { - "name": "forge_username", - "type": "string", - "ask": { - "en": "Your forge's username", - "fr": "Nom d'utilisateur de votre forge" - }, - "example": "Your username" - }, - { - "name": "forge_token", - "type": "string", - "ask": { - "en": "Your forge's token (OAuth)", - "fr": "Jeton de votre forge (OAuth)" - }, - "example": "A secret token" - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..d9cc98d --- /dev/null +++ b/manifest.toml @@ -0,0 +1,103 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "weblate" +name = "Weblate" +description.en = "Translation platform using Git and Python" +description.fr = "Plateforme de traduction utilisant Git et Python" + +version = "5.3.1~ynh1" + +maintainers = ["Thovi98"] + +[upstream] +license = "AGPL-3.0" +website = "https://weblate.org" +demo = "https://hosted.weblate.org/" +admindoc = "https://docs.weblate.org/" +userdoc = "https://docs.weblate.org/" +code = "https://github.com/WeblateOrg/weblate" +cpe = "cpe:2.3:a:weblate:weblate" +fund = "https://weblate.org/fr/donate/" + +[integration] +yunohost = ">= 11.2.0" +architectures = "all" +multi_instance = true +ldap = false +sso = false + +disk = "1G" +ram.build = "3G" +ram.runtime = "3G" + +[install] + [install.domain] + type = "domain" + + [install.path] + type = "path" + default = "/weblate" + + [install.init_main_permission] + type = "group" + default = false + + [install.admin] + type = "user" + + [install.password] + type = "password" + + [install.used_forge] + ask.en = "Choose the forge you use" + ask.fr = "Choisissez la forge que vous utilisez" + type = "select" + choices.github = "Github" + choices.gitlab = "GitLab" + default = "github" + optional = true + + [install.forge_username] + ask.en = "Your forge's username" + ask.fr = "Nom d'utilisateur de votre forge" + type = "string" + example = "Your username" + optional = true + + [install.forge_token] + ask.en = "Your forge's token (OAuth)" + ask.fr = "Jeton de votre forge (OAuth)" + type = "string" + example = "A secret token" + optional = true + +[resources] + + [resources.sources] + [resources.sources.libxxhash] + url = "https://github.com/Cyan4973/xxHash/archive/refs/tags/v0.8.1.tar.gz" + sha256 = "3bb6b7d6f30c591dd65aaaff1c8b7a5b94d81687998ca9400082c739a690436c" + in_subdir = true + autoupdate.strategy = "latest_github_tag" + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + + [resources.ports] + main.default = 8080 + + [resources.apt] + # §1 = weblate dependecies, §2 = borgbackup dependencies + packages = ["libxml2-dev", "libxslt-dev", "libfreetype6-dev", "libjpeg-dev", "libz-dev", "libyaml-dev", "libffi-dev", "libcairo-dev", "gir1.2-pango-1.0", "libgirepository1.0-dev", "libacl1-dev", "libssl-dev", "libpq-dev", "libjpeg62-turbo-dev", "build-essential", "python3-gdbm", "python3-dev", "python3-pip", "python3-venv", "python3-virtualenv", "virtualenv", "git", "uwsgi", "uwsgi-plugin-python3", "redis-server", "postgresql", "postgresql-contrib", "hub", + + + "libacl1-dev", "libacl1", "libssl-dev", "liblz4-dev", "libzstd-dev", "libxxhash-dev", "build-essential", "pkg-config", "python3-pkgconfig"] + + [resources.database] + type = "postgresql" diff --git a/scripts/_common.sh b/scripts/_common.sh index 85a0b0d..0338ce8 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,18 +4,7 @@ # COMMON VARIABLES #================================================= -# dependencies used by the app -weblate_dependencies="libxml2-dev libxslt-dev libfreetype6-dev libjpeg-dev libz-dev libyaml-dev \ - libffi-dev libcairo-dev gir1.2-pango-1.0 libgirepository1.0-dev \ - libacl1-dev libssl-dev libpq-dev libjpeg62-turbo-dev build-essential \ - python3-gdbm python3-dev python3-pip python3-virtualenv virtualenv git \ - uwsgi uwsgi-plugin-python3 redis-server postgresql postgresql-contrib hub" - -# because weblate install borgbackup -borgbackup_dependencies="libacl1-dev libacl1 libssl-dev liblz4-dev libzstd-dev libxxhash-dev \ - build-essential pkg-config python3-pkgconfig" - -pkg_dependencies="$weblate_dependencies $borgbackup_dependencies" +#REMOVEME? pkg_dependencies="$weblate_dependencies $borgbackup_dependencies" debian_maj_version=$(sed 's/\..*//' /etc/debian_version) @@ -25,6 +14,8 @@ elif [ "$debian_maj_version" -eq 10 ] ; then weblate_pypath="python3.7" elif [ "$debian_maj_version" -eq 11 ] ; then weblate_pypath="python3.9" +elif [ "$debian_maj_version" -eq 12 ] ; then + weblate_pypath="python3.11" fi #================================================= @@ -49,74 +40,6 @@ set_forge_variables() { # EXPERIMENTAL HELPERS #================================================= -# Send an email to inform the administrator -# -# usage: ynh_send_readme_to_admin app_message [recipients] -# | arg: app_message - The message to send to the administrator. -# | arg: recipients - The recipients of this email. Use spaces to separate multiples recipients. - default: root -# example: "root admin@domain" -# If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you -# example: "root admin@domain user1 user2" -ynh_send_readme_to_admin() { - local app_message="${1:-...No specific information...}" - local recipients="${2:-root}" - - # Retrieve the email of users - find_mails () { - local list_mails="$1" - local mail - local recipients=" " - # Read each mail in argument - for mail in $list_mails - do - # Keep root or a real email address as it is - if [ "$mail" = "root" ] || echo "$mail" | grep --quiet "@" - then - recipients="$recipients $mail" - else - # But replace an user name without a domain after by its email - if mail=$(ynh_user_get_info "$mail" "mail" 2> /dev/null) - then - recipients="$recipients $mail" - fi - fi - done - echo "$recipients" - } - recipients=$(find_mails "$recipients") - - local mail_subject="☁️🆈🅽🅷☁️: \`$app\` was just installed!" - - local mail_message="This is an automated message from your beloved YunoHost server. - -Specific information for the application $app. - -$app_message - ---- -Automatic diagnosis data from YunoHost - -$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')" - - # Define binary to use for mail command - if [ -e /usr/bin/bsd-mailx ] - then - local mail_bin=/usr/bin/bsd-mailx - else - local mail_bin=/usr/bin/mail.mailutils - fi - - # Send the email to the recipients - echo "$mail_message" | $mail_bin -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients" -} - -#================================================= -# -# Redis HELPERS -# -# Point of contact : Jean-Baptiste Holcroft -#================================================= - # get the first available redis database # # usage: ynh_redis_get_free_db @@ -140,7 +63,7 @@ ynh_redis_get_free_db() { db=-1 done - test "$db" -eq -1 && ynh_die "No available Redis databases..." + test "$db" -eq -1 && ynh_die --message="No available Redis databases..." echo "$db" } diff --git a/scripts/backup b/scripts/backup index 9e36f62..dbbe2a8 100755 --- a/scripts/backup +++ b/scripts/backup @@ -10,27 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading installation settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -40,7 +19,7 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= # BACKUP THE NGINX CONFIGURATION diff --git a/scripts/change_url b/scripts/change_url index e678edc..5a4d779 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -9,61 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# RETRIEVE ARGUMENTS -#================================================= - -old_domain=$YNH_APP_OLD_DOMAIN -old_path=$YNH_APP_OLD_PATH - -new_domain=$YNH_APP_NEW_DOMAIN -new_path=$YNH_APP_NEW_PATH - -app=$YNH_APP_INSTANCE_NAME - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - - -#================================================= -# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - ynh_clean_check_starting - # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. - ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# CHECK WHICH PARTS SHOULD BE CHANGED -#================================================= - -change_domain=0 -if [ "$old_domain" != "$new_domain" ] -then - change_domain=1 -fi - -change_path=0 -if [ "$old_path" != "$new_path" ] -then - change_path=1 -fi - #================================================= # STANDARD MODIFICATIONS #================================================= @@ -79,29 +24,7 @@ ynh_systemd_action --service_name="$app-celery" --action="stop" --log_path="syst #================================================= ynh_script_progression --message="Updating NGINX web server configuration..." --weight=1 -nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf - -# Change the path in the NGINX config file -if [ $change_path -eq 1 ] -then - # Make a backup of the original NGINX config file if modified - ynh_backup_if_checksum_is_different --file="$nginx_conf_path" - # Set global variables for NGINX helper - domain="$old_domain" - path_url="$new_path" - # Create a dedicated NGINX config - ynh_add_nginx_config -fi - -# Change the domain for NGINX -if [ $change_domain -eq 1 ] -then - # Delete file checksum for the old conf file location - ynh_delete_file_checksum --file="$nginx_conf_path" - mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf - # Store file checksum for the new config file location - ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" -fi +ynh_change_url_nginx_config #================================================= # SPECIFIC MODIFICATIONS @@ -110,7 +33,7 @@ fi #================================================= ynh_script_progression --message="Modify weblate's config file..." --weight=1 -settings="$final_path/venv/lib/$weblate_pypath/site-packages/weblate/settings.py" +settings="$install_dir/venv/lib/$weblate_pypath/site-packages/weblate/settings.py" ynh_backup_if_checksum_is_different --file="$settings" # Change the path in the nginx config file @@ -157,13 +80,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=5 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/weblate.log" --line_match="spawned uWSGI" ynh_systemd_action --service_name="$app-celery" --action="start" --log_path="/var/log/$app/weblate-celery-celery.log" --line_match="mingle: all alone" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/install b/scripts/install index 357b07f..4e13e85 100755 --- a/scripts/install +++ b/scripts/install @@ -9,100 +9,43 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - ynh_clean_check_starting -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST #================================================= -domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC -admin=$YNH_APP_ARG_ADMIN -password=$YNH_APP_ARG_PASSWORD -used_forge=$YNH_APP_ARG_USED_FORGE -forge_username=$YNH_APP_ARG_FORGE_USERNAME -forge_token=$YNH_APP_ARG_FORGE_TOKEN - -app=$YNH_APP_INSTANCE_NAME - admin_mail=$(ynh_user_get_info --username="$admin" --key=mail) key=$(ynh_string_random --length=50) -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - #================================================= # STORE SETTINGS FROM MANIFEST #================================================= ynh_script_progression --message="Storing installation settings..." --weight=1 -ynh_app_setting_set --app=$app --key=domain --value=$domain -ynh_app_setting_set --app=$app --key=path --value=$path_url -ynh_app_setting_set --app=$app --key=admin --value=$admin ynh_app_setting_set --app=$app --key=used_forge --value=$used_forge ynh_app_setting_set --app=$app --key=forge_username --value=$forge_username ynh_app_setting_set --app=$app --key=forge_token --value=$forge_token -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." --weight=40 - -ynh_exec_warn_less ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" --use_shell +# Remove trailing "/" from the path +path_no_slash=${path%/} #================================================= # CREATE A POSTGRESQL DATABASE #================================================= ynh_script_progression --message="Creating a PostgreSQL database..." --weight=2 -db_name=$(ynh_sanitize_dbid --db_name=$app) -db_user=$db_name -ynh_app_setting_set --app=$app --key=db_name --value=$db_name -ynh_psql_test_if_first_run -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS pg_trgm;" --database=$db_name -db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." -ynh_app_setting_set --app=$app --key=final_path --value=$final_path -mkdir -p "$final_path" -mkdir -p "$final_path/avatar-cache" -mkdir -p "$final_path/data" +mkdir -p "$install_dir/avatar-cache" +mkdir -p "$install_dir/data" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" #================================================= # NGINX CONFIGURATION @@ -134,10 +77,10 @@ ynh_secure_remove --file="$tempdir" if [ $used_forge = "GitHub" ] ; then ynh_script_progression --message="Configure hub..." --weight=1 - mkdir "$final_path/.config/" - ynh_add_config --template="../conf/hub_config" --destination="$final_path/.config/hub" + mkdir "$install_dir/.config/" + ynh_add_config --template="../conf/hub_config" --destination="$install_dir/.config/hub" - cat < "$final_path/.bashrc" + cat < "$install_dir/.bashrc" eval "$(hub alias -s /bin/bash)" EOF fi @@ -147,26 +90,27 @@ fi #================================================= ynh_script_progression --message="Install weblate using PIP..." --weight=80 -virtualenv --python=python3 "${final_path}/venv" -chown -R $app: "$final_path" +virtualenv --python=python3 "${install_dir}/venv" +chown -R $app: "$install_dir" #run source in a 'sub shell' ( set +o nounset - source "${final_path}/venv/bin/activate" + source "${install_dir}/venv/bin/activate" set -o nounset - cd "${final_path}" + cd "${install_dir}" - sudo --user=$app $final_path/venv/bin/pip install --upgrade pip setuptools wheel pkgconfig xxhash + sudo --user=$app $install_dir/venv/bin/pip install --upgrade pip setuptools wheel pkgconfig xxhash # Read the "Note" section in https://docs.weblate.org/en/weblate-4.11/admin/install/venv-debian.html#python-modules - sudo --user=$app $final_path/venv/bin/pip install --force-reinstall --no-binary :all: cffi + sudo --user=$app $install_dir/venv/bin/pip install --force-reinstall --no-binary :all: cffi # Still needed with latest version of weblate? - sudo --user=$app BORG_OPENSSL_PREFIX=/usr/lib/x86_64-linux-gnu/ $final_path/venv/bin/pip install Weblate=="$(ynh_app_upstream_version)" - sudo --user=$app $final_path/venv/bin/pip install psycopg2-binary ruamel.yaml aeidon phply + sudo --user=$app BORG_OPENSSL_PREFIX=/usr/lib/x86_64-linux-gnu/ $install_dir/venv/bin/pip install Weblate=="$(ynh_app_upstream_version)" + sudo --user=$app $install_dir/venv/bin/pip install psycopg2-binary ruamel.yaml aeidon phply boto3 google openai #pip install pytz python-bidi PyYaML Babel pyuca pylibravatar py3dns psycopg2-binary phply django-redis hiredis aeidon ruamel.yaml + # specific to YunoHost package: - sudo --user=$app $final_path/venv/bin/pip install django_sendmail_backend + sudo --user=$app $install_dir/venv/bin/pip install django_sendmail_backend ) #================================================= @@ -176,24 +120,23 @@ ynh_script_progression --message="Adding a configuration file..." --weight=1 redis_db=$(ynh_redis_get_free_db) ynh_app_setting_set --app=$app --key=redis_db --value="$redis_db" -path_url="${path_url%/}" -settings="$final_path/venv/lib/$weblate_pypath/site-packages/weblate/settings.py" +settings="$install_dir/venv/lib/$weblate_pypath/site-packages/weblate/settings.py" set_forge_variables ynh_add_config --template="../conf/settings.py" --destination="$settings" -ynh_add_config --template="../conf/celery-weblate" --destination="$final_path/celery-weblate" +ynh_add_config --template="../conf/celery-weblate" --destination="$install_dir/celery-weblate" ynh_add_config --template="../conf/uwsgi.ini" --destination="/etc/uwsgi/apps-available/$app.ini" -touch "$final_path/local_settings.py" -ln -sf "$final_path/local_settings.py" "$final_path/venv/lib/$weblate_pypath/site-packages/weblate/local_settings.py" +touch "$install_dir/local_settings.py" +ln -sf "$install_dir/local_settings.py" "$install_dir/venv/lib/$weblate_pypath/site-packages/weblate/local_settings.py" # Set permissions to app files -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app: "$final_path" -chown "$app:www-data" "$final_path" -chown -R "$app:www-data" "$final_path/data" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app: "$install_dir" +chown "$app:www-data" "$install_dir" +chown -R "$app:www-data" "$install_dir/data" #================================================= # SPECIFIC SETUP Filling up the database @@ -203,23 +146,28 @@ ynh_script_progression --message="Filling up the database..." --weight=10 ( set +o nounset - source "${final_path}/venv/bin/activate" + source "${install_dir}/venv/bin/activate" set -o nounset export DJANGO_SETTINGS_MODULE="weblate.settings" - cd "${final_path}" + cd "${install_dir}" # the user needs to be weblate for postgresql - ynh_exec_warn_less sudo --user=$app $final_path/venv/bin/weblate migrate --noinput - # generate static files - ynh_exec_warn_less sudo --user=$app $final_path/venv/bin/weblate collectstatic --noinput - ynh_exec_warn_less sudo --user=$app $final_path/venv/bin/weblate createadmin --no-color \ + ynh_exec_warn_less sudo --user=$app $install_dir/venv/bin/weblate migrate --noinput + + ynh_exec_warn_less sudo --user=$app $install_dir/venv/bin/weblate createadmin --no-color \ --password "$password" \ --username "$admin" \ --email "$admin_mail" + # generate static files + ynh_exec_warn_less sudo --user=$app $install_dir/venv/bin/weblate collectstatic --noinput + + # https://docs.weblate.org/en/latest/admin/install/venv-debian.html + ynh_exec_warn_less sudo --user=$app $install_dir/venv/bin/weblate compress + # Check the configuration # This may fail in some cases with errors, etc., but the app works and the user can fix issues later. - ynh_exec_warn_less sudo --user=$app $final_path/venv/bin/weblate check --deploy || true + ynh_exec_warn_less sudo --user=$app $install_dir/venv/bin/weblate check --deploy || true ) #================================================= @@ -256,37 +204,6 @@ ynh_script_progression --message="Starting a systemd service..." --weight=5 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/weblate.log" --line_match="spawned uWSGI" ynh_systemd_action --service_name="$app-celery" --action="start" --log_path="/var/log/$app/weblate-celery-celery.log" --line_match="mingle: all alone" -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 - -# Make app public if necessary -if [ $is_public -eq 1 ] -then - # Everyone can access the app. - # The "main" permission is automatically created before the install script. - ynh_permission_update --permission="main" --add="visitors" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name="nginx" --action="reload" - -#================================================= -# SEND A README FOR THE ADMIN -#================================================= - -message=" -Weblate settings file : $settings -If you facing an issue or want to improve this app, please open a new issue in this project: https://github.com/YunoHost-Apps/weblate_ynh -" - -ynh_send_readme_to_admin "$message" "$admin" - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/remove b/scripts/remove index 40bb765..f6d4bd6 100755 --- a/scripts/remove +++ b/scripts/remove @@ -9,18 +9,6 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - #================================================= # STANDARD REMOVE #================================================= @@ -58,22 +46,6 @@ ynh_script_progression --message="Removing logrotate configuration..." --weight= # Remove the app-specific logrotate config ynh_remove_logrotate -#================================================= -# REMOVE THE POSTGRESQL DATABASE -#================================================= -ynh_script_progression --message="Removing the PostgreSQL database..." --weight=1 - -# Remove a database if it exists, along with the associated user -ynh_psql_remove_db --db_user=$db_user --db_name=$db_name - -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=2 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - #================================================= # REMOVE NGINX CONFIGURATION #================================================= @@ -82,14 +54,6 @@ ynh_script_progression --message="Removing NGINX web server configuration..." -- # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=10 - -# Remove metapackage and its dependencies -ynh_exec_warn_less ynh_remove_app_dependencies - #================================================= # REMOVE XXHASH #================================================= @@ -116,16 +80,6 @@ ynh_secure_remove --file="/var/run/$app-celery" ynh_redis_remove_db -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index 79712aa..0263875 100755 --- a/scripts/restore +++ b/scripts/restore @@ -10,72 +10,21 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - ynh_clean_check_starting -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading installation settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=1 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" --use_shell - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=4 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -touch "$final_path/local_settings.py" -ln -sf "$final_path/local_settings.py" "$final_path/venv/lib/$weblate_pypath/site-packages/weblate/local_settings.py" +touch "$install_dir/local_settings.py" +ln -sf "$install_dir/local_settings.py" "$install_dir/venv/lib/$weblate_pypath/site-packages/weblate/local_settings.py" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app: "$final_path" -chown $app:www-data "$final_path" -chown -R $app:www-data "$final_path/data" - -#================================================= -# SPECIFIC RESTORATION -#================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=40 - -# Define and install dependencies -ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app: "$install_dir" +chown $app:www-data "$install_dir" +chown -R $app:www-data "$install_dir/data" #================================================= # RESTORE THE NGINX CONFIGURATION @@ -89,10 +38,6 @@ ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= ynh_script_progression --message="Restoring the PostgreSQL database..." --weight=5 -db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) -ynh_psql_test_if_first_run -ynh_psql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd -ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS pg_trgm;" --database=$db_name ynh_psql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql #================================================= @@ -147,7 +92,7 @@ yunohost service add "$app-celery" --log="/var/log/$app/weblate-celery-w1.log" ynh_script_progression --message="Starting a systemd service..." --weight=5 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/weblate.log" --line_match="spawned uWSGI" -ynh_systemd_action --service_name="$app-celery" --action="start" --log_path="/var/log/$app/weblate-celery-celery.log" --line_match="mingle: all alone" +ynh_systemd_action --service_name="$app-celery" --action="start" --log_path="/var/log/$app/weblate-celery-w1.log" --line_match="mingle: all alone" #================================================= # GENERIC FINALIZATION diff --git a/scripts/upgrade b/scripts/upgrade index e097eea..6dea564 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -14,44 +14,18 @@ source /usr/share/yunohost/helpers #================================================= ynh_script_progression --message="Loading installation settings..." --weight=1 -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -admin=$(ynh_app_setting_get --app=$app --key=admin) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -db_pwd=$(ynh_app_setting_get --app=$app --key=psqlpwd) -used_forge=$(ynh_app_setting_get --app=$app --key=used_forge) -forge_username=$(ynh_app_setting_get --app=$app --key=forge_username) -forge_token=$(ynh_app_setting_get --app=$app --key=forge_token) -redis_db=$(ynh_app_setting_get --app=$app --key=redis_db) - admin_mail=$(ynh_user_get_info --username="$admin" --key=mail) key=$(ynh_string_random --length=50) +# Remove trailing "/" from the path +path_no_slash=${path%/} + #================================================= # CHECK VERSION #================================================= upgrade_type=$(ynh_check_app_version_changed) -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=40 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - ynh_clean_check_starting - # Restore it if the upgrade fails - ynh_restore_upgradebackup -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - #================================================= # STANDARD UPGRADE STEPS #================================================= @@ -67,27 +41,6 @@ ynh_systemd_action --service_name="$app-celery" --action="stop" --log_path="syst #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 -if ynh_legacy_permissions_exists -then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -if [[ -d "$final_path/bin/" ]] -then - ynh_secure_remove --file="$final_path/bin/" -fi - -# (<3.8) log cleanups -if [[ -e "/var/log/uwsgi/app/$app" ]] -then - ynh_systemd_action --service_name=$app --action="stop" - ynh_systemd_action --service_name="$app-celery" --action="stop" - ynh_secure_remove --file="/var/log/uwsgi/app/$app" - ynh_secure_remove --file="/var/log/$app-celery" -fi - # If used_forge, forge_username, forge_token don't exist, create them if [ -z "$used_forge" ]; then used_forge="GitHub" @@ -98,21 +51,6 @@ if [ -z "$used_forge" ]; then ynh_app_setting_set --app=$app --key=forge_token --value=$forge_token fi -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" --use_shell - -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=5 - -ynh_exec_warn_less ynh_install_app_dependencies "$pkg_dependencies" - #================================================= # NGINX CONFIGURATION #================================================= @@ -143,10 +81,10 @@ ynh_secure_remove --file="$tempdir" if [ $used_forge = "GitHub" ] ; then ynh_script_progression --message="Configure hub..." --weight=1 - #mkdir "$final_path/.config/" - ynh_add_config --template="../conf/hub_config" --destination="$final_path/.config/hub" + #mkdir "$install_dir/.config/" + ynh_add_config --template="../conf/hub_config" --destination="$install_dir/.config/hub" - cat < "$final_path/.bashrc" + cat < "$install_dir/.bashrc" eval "$(hub alias -s /bin/bash)" EOF fi @@ -158,7 +96,7 @@ ynh_script_progression --message="Updating a configuration file..." --weight=2 ynh_add_config --template="../conf/uwsgi.ini" --destination="/etc/uwsgi/apps-available/$app.ini" -ynh_add_config --template="../conf/celery-weblate" --destination="$final_path/celery-weblate" +ynh_add_config --template="../conf/celery-weblate" --destination="$install_dir/celery-weblate" #================================================= # SETUP SYSTEMD @@ -180,27 +118,27 @@ upgrade() { #================================================= ynh_script_progression --message="Install weblate using PIP..." --weight=15 - ynh_secure_remove --file="${final_path}/venv" - virtualenv --python=python3 "${final_path}/venv" - chown -R $app: "$final_path" + ynh_secure_remove --file="${install_dir}/venv" + virtualenv --python=python3 "${install_dir}/venv" + chown -R $app: "$install_dir" #run source in a 'sub shell' ( set +o nounset - source "${final_path}/venv/bin/activate" + source "${install_dir}/venv/bin/activate" set -o nounset - cd "${final_path}" + cd "${install_dir}" - sudo --user=$app $final_path/venv/bin/pip install --upgrade pip setuptools wheel pkgconfig xxhash + sudo --user=$app $install_dir/venv/bin/pip install --upgrade pip setuptools wheel pkgconfig xxhash # Read the "Note" section in https://docs.weblate.org/en/weblate-4.11/admin/install/venv-debian.html#python-modules - sudo --user=$app $final_path/venv/bin/pip install --force-reinstall --no-binary :all: cffi + sudo --user=$app $install_dir/venv/bin/pip install --force-reinstall --no-binary :all: cffi # Still needed with latest version of weblate? - sudo --user=$app $final_path/venv/bin/pip install --upgrade Weblate=="$new_version" - sudo --user=$app $final_path/venv/bin/pip install psycopg2-binary ruamel.yaml aeidon phply + sudo --user=$app $install_dir/venv/bin/pip install --upgrade Weblate=="$new_version" + sudo --user=$app $install_dir/venv/bin/pip install psycopg2-binary ruamel.yaml aeidon phply boto3 google openai #pip install pytz python-bidi PyYaML Babel pyuca pylibravatar py3dns psycopg2-binary phply django-redis hiredis aeidon ruamel.yaml # specific to YunoHost package: - sudo --user=$app $final_path/venv/bin/pip install django_sendmail_backend + sudo --user=$app $install_dir/venv/bin/pip install django_sendmail_backend ) #================================================= @@ -208,8 +146,8 @@ upgrade() { #================================================= ynh_script_progression --message="Create weblate configuration file..." --weight=2 # save old settings file - settings="$final_path/venv/lib/$weblate_pypath/site-packages/weblate/settings.py" - path_url="${path_url%/}" + settings="$install_dir/venv/lib/$weblate_pypath/site-packages/weblate/settings.py" + path="${path%/}" set_forge_variables @@ -220,8 +158,8 @@ upgrade() { # Recalculate and store the config file checksum into the app settings ynh_store_file_checksum --file="$settings" - touch "$final_path/local_settings.py" - ln -sf "$final_path/local_settings.py" "$final_path/venv/lib/$weblate_pypath/site-packages/weblate/local_settings.py" + touch "$install_dir/local_settings.py" + ln -sf "$install_dir/local_settings.py" "$install_dir/venv/lib/$weblate_pypath/site-packages/weblate/local_settings.py" #================================================= # MIGRATE WEBLATE @@ -232,34 +170,35 @@ upgrade() { ( set +o nounset - source "${final_path}/venv/bin/activate" + source "${install_dir}/venv/bin/activate" set -o nounset export DJANGO_SETTINGS_MODULE="weblate.settings" - cd "${final_path}" + cd "${install_dir}" + + sudo --user=$app $install_dir/venv/bin/weblate migrate --noinput + sudo --user=$app $install_dir/venv/bin/weblate collectstatic --noinput + sudo --user=$app $install_dir/venv/bin/weblate setuplang + sudo --user=$app $install_dir/venv/bin/weblate setupgroups + sudo --user=$app $install_dir/venv/bin/weblate compilemessages + sudo --user=$app $install_dir/venv/bin/weblate compress - sudo --user=$app $final_path/venv/bin/weblate migrate --noinput - sudo --user=$app $final_path/venv/bin/weblate collectstatic --noinput - sudo --user=$app $final_path/venv/bin/weblate setuplang - sudo --user=$app $final_path/venv/bin/weblate setupgroups - sudo --user=$app $final_path/venv/bin/weblate compilemessages - # Check the configuration # This may fail in some cases with errors, etc., but the app works and the user can fix issues later. if [ "$new_version" == "$(ynh_app_upstream_version)" ]; then - sudo --user=$app $final_path/venv/bin/weblate check --deploy || true + sudo --user=$app $install_dir/venv/bin/weblate check --deploy || true fi ) ynh_systemd_action --service_name="$app-celery" --action="stop" } -file_version="${final_path}/venv/lib/$weblate_pypath/site-packages/weblate/__init__.py" +file_version="${install_dir}/venv/lib/$weblate_pypath/site-packages/weblate/__init__.py" if [ -e $file_version ] then current_version=$(cat $file_version | grep "^VERSION = " | grep -o "[0-9].[0-9]" | head -n1 | cut -d"." -f1) if [ -z "$current_version" ] then - file_version="${final_path}/venv/lib/$weblate_pypath/site-packages/weblate/utils/version.py" + file_version="${install_dir}/venv/lib/$weblate_pypath/site-packages/weblate/utils/version.py" current_version=$(cat $file_version | grep "^VERSION = " | grep -o "[0-9].[0-9]" | head -n1 | cut -d"." -f1) fi else @@ -268,21 +207,16 @@ fi ynh_psql_execute_as_root --sql="CREATE EXTENSION IF NOT EXISTS pg_trgm;" --database=$db_name -if [ "$current_version" -lt "4" ] -then - upgrade "4.1.1" "../conf/settings.4.1.1.py" -fi - upgrade $(ynh_app_upstream_version) "../conf/settings.py" # Set right permissions for curl installation -mkdir -p "$final_path/avatar-cache" -chown -R $app: "$final_path" -chown "$app:www-data" "$final_path" -chown -R "$app:www-data" "$final_path/data" +mkdir -p "$install_dir/avatar-cache" +chown -R $app: "$install_dir" +chown "$app:www-data" "$install_dir" +chown -R "$app:www-data" "$install_dir/data" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" #================================================= # GENERIC FINALIZATION @@ -310,13 +244,6 @@ ynh_script_progression --message="Starting systemd services..." --weight=5 ynh_systemd_action --service_name=$app --action="start" --log_path="/var/log/$app/weblate.log" --line_match="spawned uWSGI" ynh_systemd_action --service_name="$app-celery" --action="start" --log_path="/var/log/$app/weblate-celery-celery.log" --line_match="mingle: all alone" -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload - #================================================= # END OF SCRIPT #================================================= diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..ef21ba7 --- /dev/null +++ b/tests.toml @@ -0,0 +1,26 @@ +test_format = 1.0 + +[default] + + # ------------ + # Tests to run + # ------------ + + + # ------------------------------- + # Default args to use for install + # ------------------------------- + + + # ------------------------------- + # Commits to test upgrade from + # ------------------------------- + + test_upgrade_from.2749e7b.name = "5.3.1 - packaging v1" + test_upgrade_from.2749e7b.args.domain = "domain.tld" + test_upgrade_from.2749e7b.args.path = "/" + test_upgrade_from.2749e7b.args.is_public = true + test_upgrade_from.2749e7b.args.admin = "package_checker" + test_upgrade_from.2749e7b.args.password = "password" + test_upgrade_from.2749e7b.args.used_forge = "GitHub" + test_upgrade_from.2749e7b.args.forge_token = "11111111111"