No-bullshit file hosting and URL shortening service
Go to file
Emi Simpson 7bb18b17dc
config.example.py: Add min & max expiration + description
2022-11-28 17:09:18 -05:00
instance config.example.py: Add min & max expiration + description 2022-11-28 17:09:18 -05:00
migrations Remove vestigial database model 2022-11-28 16:43:34 -05:00
nsfw_model Add NSFW detection 2017-10-27 05:28:45 +02:00
templates Show correct times on the index page graph 2022-11-22 17:16:38 -05:00
tests Add tests 2021-05-23 19:13:51 +02:00
.gitignore Support instance config 2021-05-23 19:13:51 +02:00
.mailmap Add mailmap 2021-05-23 19:13:51 +02:00
LICENSE Change license to EUPL 2020-11-03 04:01:30 +01:00
README.rst Merge remote-tracking branch 'mia/master' into expiration 2022-11-28 17:05:40 -05:00
cleanup.py Improve the migration script, removing the need for --legacy 2022-11-26 21:24:00 -05:00
fhost.py prune: Stream expired files from the database 2022-11-28 16:49:09 -05:00
nsfw_detect.py Fix some flake8 errors in cleanup and nsfw_detect 2021-08-06 15:19:08 -04:00
pyproject.toml Add tests 2021-05-23 19:13:51 +02:00
requirements.txt remove short_url and add in-tree URLencoder (#53) 2021-12-01 13:25:33 +01:00

README.rst

The Null Pointer

This is a no-bullshit file hosting and URL shortening service that also runs 0x0.st. Use with uWSGI.

Configuration

To configure 0x0, 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, 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 configs server block:

location /up {
    internal;
}

where /up is whatever youve 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 wont be possible to seek, and some ISOBMFF (MP4) files will not play at all.

To make files expire, simply create a cronjob that runs FLASK_APP=fhost flask prune every now and then.

Before running the service for the first time, run FLASK_APP=fhost flask db upgrade.

NSFW Detection

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

  • Caffe Python module (built for Python 3)
  • ffmpegthumbnailer executable in $PATH

Network Security Considerations

Keep in mind that 0x0 can fetch files from URLs. This includes your local network! You should take precautions so that this feature cannot be abused. 0x0 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, its 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.