No-nonsense file upload and url shortening service, fork of 0x0
ファイルへ移動
Izuru Yakumo 363d4f49a7 Rid of every systemd reference
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja>
2023-05-19 16:21:04 -03:00
instance Add moderation TUI 2022-12-20 16:19:49 +01:00
migrations Store user agent with files 2023-03-29 07:36:49 +02:00
modui ModUI: Add application/xml to text handler 2022-12-22 09:55:41 +01:00
nsfw_model
templates It's 0x0a not 0x0 2023-05-19 16:07:48 -03:00
tests Fix URL test issue 2022-12-13 23:18:40 +01:00
.gitignore
.mailmap
0x0a-prune.crontab Rid of every systemd reference 2023-05-19 16:21:04 -03:00
0x0a-vscan.crontab Rid of every systemd reference 2023-05-19 16:21:04 -03:00
LICENSE
README.md Rid of every systemd reference 2023-05-19 16:21:04 -03:00
app.ini Added sample service file and sample app.ini, reworked main template. 2023-04-11 16:18:53 -03:00
cleanup.py Add support for expiring files 2022-11-29 13:09:26 +01:00
fhost.py Store user agent with files 2023-03-29 07:36:49 +02:00
mod.css Add moderation TUI 2022-12-20 16:19:49 +01:00
mod.py ModUI: Handle opening filter panel with NULL user agent 2023-03-29 07:49:56 +02:00
modui.webp README: Add ModUI screenshot 2022-12-20 16:57:07 +01:00
nsfw_detect.py nsfw_detect: Use PyAV instead of ffmpegthumbnailer 2022-11-29 21:54:43 +01:00
pyproject.toml Add tests 2021-05-23 19:13:51 +02:00
requirements.txt Update requirements.txt 2022-12-20 16:19:49 +01:00

README.md

「null:ポインタ」

This is a no-bullshit file hosting and URL shortening service. Use with uWSGI.

Configuration

To configure 0x0a, copy instance/config.example.py to instance/config.py, then edit it. Resonable defaults are set, but there's a couple options you'll need to change before running 0x0 for the first time.

By default, the configuration is stored in the Flask instance directory. Normally, this is in [./instance]{.title-ref}, but it might be different for your system. For details, see the Flask documentation.

To customize the home and error pages, simply create a templates directory in your instance directory and copy any templates you want to modify there.

If you are running nginx, you should use the X-Accel-Redirect header. To make it work, include this in your nginx config's server block:

location /up {
    internal;
}

where /up is whatever you've configured as FHOST_STORAGE_PATH.

For all other servers, set FHOST_USE_X_ACCEL_REDIRECT to False and USE_X_SENDFILE to True, assuming your server supports this. Otherwise, Flask will serve the file with chunked encoding, which has several downsides, one of them being that range requests will not work. This is a problem for example when streaming media files: It won't be possible to seek, and some ISOBMFF (MP4) files will not play at all.

To make files expire, simply run FLASK_APP=fhost flask prune every now and then. You can use the provided crontab files for this.

Make sure to edit them to match your system configuration, assuming you have read crontab(5) on a sane OS.

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

image{height="300px"}

0x0a 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 sixels and the kitty graphics protocol. For this to work, set the MOD_PREVIEW_PROTO option in instance/config.py.

Requirements:

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

0x0a supports classification of NSFW content via Yahoo's open_nsfw Caffe neural network model. This works for images and video files and requires the following:

  • Caffe Python module (built for Python 3)
  • PyAV

Virus Scanning

0x0 can scan its files with ClamAV's daemon. As this can take a long time for larger files, this does not happen immediately but instead every time you run the vscan command. It is recommended to configure a systemd timer or cronjob to do this periodically. Examples are included:

0x0a-vscan.crontab

Remember to adjust your size limits in clamd.conf, including StreamMaxLength!

This feature requires the clamd module.

Network Security Considerations

Keep in mind that 0x0a can fetch files from URLs. This includes your local network! You should take precautions so that this feature cannot be abused. 0x0a does not (yet) have a way to filter remote URLs, but on Linux, you can use firewall rules and/or namespaces. This is less error-prone anyway.

For instance, if you are using the excellent FireHOL, it's very easy to create a group on your system and use it as a condition in your firewall rules. You would then run the application server under that group.

Credits