From eebd5d8c6d8a756384b6cf1b2cc76b8a83cdf929 Mon Sep 17 00:00:00 2001 From: Mia Herkt Date: Tue, 20 Dec 2022 15:45:55 +0100 Subject: Add moderation TUI This ended up way fancier than I imagined. --- README.rst | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 8c512de..078f5b2 100644 --- a/README.rst +++ b/README.rst @@ -48,6 +48,48 @@ Before running the service for the first time and every time you update it from this git repository, run ``FLASK_APP=fhost flask db upgrade``. +Moderation UI +------------- + +0x0 features a TUI program for file moderation. With it, you can view a list +of uploaded files, as well as extended information on them. It allows you to +take actions like removing files temporarily or permanently, as well as +blocking IP addresses and associated files. + +If a sufficiently recent version of python-mpv with libmpv is present and +your terminal supports it, you also get graphical file previews, including +video playback. Upstream mpv currently supports sixel graphics, but there is +`an open pull request `_ that +adds support for the `kitty graphics protocol `_. +For this to work, set the ``MOD_PREVIEW_PROTO`` option in ``instance/config.py``. + +Requirements: + +* `Textual `_ + +Optional: + +* `python-mpv `_ + (graphical previews) +* `PyAV `_ + (information on multimedia files) +* `PyMuPDF `_ + (previews and file information for PDF, XPS, EPUB, MOBI and FB2) +* `libarchive-c `_ + (archive content listing) + +.. note:: + `Mosh `_ currently does not support sixels or kitty graphics. + +.. hint:: + You may need to set the ``COLORTERM`` environment variable to + ``truecolor``. + +.. tip:: + Using compression with SSH (``-C`` option) can significantly + reduce the bandwidth requirements for graphics. + + NSFW Detection -------------- -- cgit v1.2.3