diff --git a/README.md b/README.md index f6af251..3722f82 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,24 @@ Create a superuser account ``` +### Repository Quota Updates + +The repository quotas in the UI are updated after each backup. +To update the quota during an operation the `update_used_quota` management command can be executed on a regular basis. + +There are example configs for systemd-timers in `contrib/communitybackup-quota-update.service` and `contrib/communitybackup-quota-update.timer`. Adjust the paths and the timers to your needs. + + +## Custom pages + +Some pages are specific to your installation. E.g. an imprint. + +Those files are markdown files that are rendered as HTML. You have to supply them and put them into the `MARKDOWN_PAGE_DIR`. + +The following files are expected: + +* `imprint.md` with your imprint information. + ## Settings ### BACKUP_USER @@ -112,3 +130,49 @@ DATABASES = { } } ``` + +### SECRET_KEY + +The secret key used by django for session cookies and other things. + +### DEBUG + +Django debug setting. + +### MARKDOWN_PAGE_DIR + +`MARKDOWN_PAGE_DIR` is the directory where customized markdown files are put. This directory is required. + +### BACKUP_MANAGE_PY + +`BACKUP_MANAGE_PY` is the command to run the `manage.py` file, including e.g. a Python interpreter, venv, etc. This must be a `pathlib.Path` + +### ADDITIONAL_FOOTER_NAV_ITEMS + +`ADDITIONAL_FOOTER_NAV_ITEMS` allows you to add additional links to the footer. This is a `list[str]`. Each item gets rendered as is into a `
  • `. So usually you want to continue the proper Bootstrap styling in the lst. E.g.: + +```python +ADDITIONAL_FOOTER_NAV_ITEMS = [""" str: - return f"{settings.BACKUP_USER}@{settings.BACKUP_REPO_HOST}:{self.user.pk}/{self.pk}" + return f"ssh://{settings.BACKUP_USER}@{settings.BACKUP_REPO_HOST}/./{self.user.pk}/{self.pk}" - def save(self): + def save(self, *args, **kwargs): - super().save() + super().save(*args, **kwargs) update_user.enqueue() def delete(self): @@ -56,6 +60,60 @@ class BorgRepository(models.Model): super().delete() update_user.enqueue() + @property + def key_type(self) -> str: + return self.key.split(" ", 1)[0].strip() + + @property + def key_value(self) -> str: + return self.key.split(" ", 2)[1].strip() + + @property + def key_comment(self) -> str | None: + splits = self.key.split(" ", 2) + if len(splits) == 3: + return splits[2].strip() + return None + + def truncated_key(self, length: int = 60): + """ + Returns a truncated version of the key for display purposes. + The Key type and the comment are retained as much as possible. + """ + + # check how long the truncated part of the key may be at most. + max_len = length - len(self.key_type) - 1 + if self.key_comment: + max_len = max_len - len(self.key_comment) - 1 + + if len(self.key_value) > max_len: + max_len -= 1 # remove one character if we add an ellipsis + trunc_key = self.key_value[:max_len] + "…" + else: + trunc_key = self.key_value + + output = f"{self.key_type} {trunc_key}" + + if self.key_comment: + output += f" {self.key_comment}" + + return output + + def refresh_quota(self): + hints_files = self.path.glob("hints.*") + + try: + hint = next(hints_files) + data = hint.open(mode="rb").read() + + unpacked = msgpack.unpackb(data, strict_map_key=False, raw=True) + quota_used = unpacked[b"storage_quota_use"] + + self.used_quota = int(quota_used / 10**9) + except StopIteration: + # No hints file found, therefore the repo is probably not initialized + self.used_quota = -1 + class Voucher(models.Model): used = models.BooleanField(default=False) diff --git a/community_backup/webui/templates/about.md b/community_backup/webui/templates/about.md deleted file mode 100644 index 12e7d3c..0000000 --- a/community_backup/webui/templates/about.md +++ /dev/null @@ -1,6 +0,0 @@ -# About Community Backup - -Community Backup is a service that provides backup space free of charge. - -* This is -* a list diff --git a/community_backup/webui/templates/base.html b/community_backup/webui/templates/base.html index ffa2b06..b418e2b 100644 --- a/community_backup/webui/templates/base.html +++ b/community_backup/webui/templates/base.html @@ -46,11 +46,38 @@ diff --git a/community_backup/webui/templates/borg_list.html b/community_backup/webui/templates/borg_list.html index b193fcd..2f6e7c7 100644 --- a/community_backup/webui/templates/borg_list.html +++ b/community_backup/webui/templates/borg_list.html @@ -18,14 +18,16 @@ Name Key Repo-URL + Quota (used/total) {% for repo in object_list %} {{ repo.name }} - {{ repo.key | truncatechars:40 }} - {{ repo.repo_url}} + {{ repo.truncated_key }} + {{ repo.repo_url }} + {% if repo.used_quota < 0 %}not initialized{% else %}{{ repo.used_quota }}/{{ repo.quota }} GB{% endif %} Edit Delete @@ -33,6 +35,21 @@ +{% if BORG_SERVER_PUBKEYS %} +
    +
    +

    Borg Server Public Keys

    +
    + +
    +{% endif %} diff --git a/community_backup/webui/templates/landing.html b/community_backup/webui/templates/landing.html index 39db761..a9960f9 100644 --- a/community_backup/webui/templates/landing.html +++ b/community_backup/webui/templates/landing.html @@ -6,7 +6,7 @@ -

    This is a service offering space for backups free of charge. This is a hobby project. It comes with no garantuees for anything, especially availability of the service. This service is in a testing phase at the moment. It might be unavailalbe at times and features might change quickly.

    +

    This is a service offering space for backups free of charge. This is a hobby project. It comes with no guarantees for anything, especially availability of the service. This service is in a testing phase at the moment. It might be unavailable at times and features might change quickly.

    Currently this service offers only backups via Borg Backup.

    To access this service you need an account. To register for an account you need a voucher. Vouchers are required to control the amount of users, so that there is enough space available for everyone.

     diff --git a/community_backup/webui/views.py b/community_backup/webui/views.py index f265477..249f861 100644 --- a/community_backup/webui/views.py +++ b/community_backup/webui/views.py @@ -2,13 +2,12 @@ from django.shortcuts import get_object_or_404 from django.views.generic.base import TemplateView from django.views.generic import ListView, FormView from django.views.generic.edit import CreateView, UpdateView, DeleteView +from django.conf import settings from django.contrib.auth.models import User from django.contrib.auth.forms import BaseUserCreationForm from django.contrib.auth.mixins import UserPassesTestMixin, LoginRequiredMixin -from django.template.loader import get_template - from django.core.exceptions import ValidationError import markdown2 @@ -36,7 +35,8 @@ class MarkdownView(TemplateView): def get_context_data(self, **kwargs): context = super().get_context_data(**kwargs) - source = get_template(self.md).template.source + + source = (settings.MARKDOWN_PAGE_DIR / self.md).read_text() context["markdown_content"] = markdown2.markdown(source) return context diff --git a/pyproject.toml b/pyproject.toml index 412eb3e..2412b09 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "community_backup" -version = "0.1.0" +version = "0.12" description = "Add your description here" readme = "README.md" requires-python = ">=3.13" @@ -10,4 +10,5 @@ dependencies = [ "django-crispy-forms>=2.6", "gunicorn>=25.3.0", "markdown2>=2.5.5", + "msgpack>=1.1.2", ]