No-bullshit file hosting and URL shortening service https://0x0.st
Find a file
2021-10-19 00:51:20 +00:00
migrations Add NSFW detection 2017-10-27 05:28:45 +02:00
nsfw_model Add NSFW detection 2017-10-27 05:28:45 +02:00
templates Use template responses 2021-05-23 19:13:51 +02: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
cleanup.py Change license to EUPL 2020-11-03 04:01:30 +01:00
fhost.py Refactor min_length of urls 2021-10-19 00:39:09 +00:00
LICENSE Change license to EUPL 2020-11-03 04:01:30 +01:00
nsfw_detect.py Change license to EUPL 2020-11-03 04:01:30 +01:00
pyproject.toml Add tests 2021-05-23 19:13:51 +02:00
README.rst Support instance templates 2021-05-23 19:13:51 +02:00
requirements.txt Forgot to remove dependency 2021-10-19 00:51:20 +00:00

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

The Null Pointer
================

This is a no-bullshit file hosting and URL shortening service that also runs
`0x0.st <https://0x0.st>`_. Use with uWSGI.

Configuration
-------------

To change settings, modify ``instance/config.py``. For more information on
instance configuration, see `the Flask documentation <https://flask.palletsprojects.com/en/2.0.x/config/#instance-folders>`_.

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 sucks and
should be avoided at all costs.

To make files expire, simply create a cronjob that runs ``cleanup.py`` 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``