Atualizar 'README.rst'

This commit is contained in:
Tiago Esperança Triques 2023-04-05 21:04:53 +00:00
parent c2b5e95903
commit 5386822ad8

View file

@ -20,19 +20,19 @@ 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. 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. 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:: To make it work, include this in your nginx config's ``server`` block::
location /up { location /up {
internal; internal;
} }
where ``/up`` is whatever youve configured as ``FHOST_STORAGE_PATH``. where ``/up`` is whatever you've configured as ``FHOST_STORAGE_PATH``.
For all other servers, set ``FHOST_USE_X_ACCEL_REDIRECT`` to ``False`` and For all other servers, set ``FHOST_USE_X_ACCEL_REDIRECT`` to ``False`` and
``USE_X_SENDFILE`` to ``True``, assuming your server supports this. ``USE_X_SENDFILE`` to ``True``, assuming your server supports this.
Otherwise, Flask will serve the file with chunked encoding, which has several 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 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, problem for example when streaming media files: It won't be possible to seek,
and some ISOBMFF (MP4) files will not play at all. and some ISOBMFF (MP4) files will not play at all.
To make files expire, simply run ``FLASK_APP=fhost flask prune`` every To make files expire, simply run ``FLASK_APP=fhost flask prune`` every
@ -95,7 +95,7 @@ Optional:
NSFW Detection NSFW Detection
-------------- --------------
0x0 supports classification of NSFW content via Yahoos open_nsfw Caffe 0x0 supports classification of NSFW content via Yahoo's open_nsfw Caffe
neural network model. This works for images and video files and requires neural network model. This works for images and video files and requires
the following: the following:
@ -106,7 +106,7 @@ the following:
Virus Scanning Virus Scanning
-------------- --------------
0x0 can scan its files with ClamAVs daemon. As this can take a long time 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 for larger files, this does not happen immediately but instead every time
you run the ``vscan`` command. It is recommended to configure a systemd you run the ``vscan`` command. It is recommended to configure a systemd
timer or cronjob to do this periodically. Examples are included:: timer or cronjob to do this periodically. Examples are included::
@ -129,6 +129,6 @@ network! You should take precautions so that this feature cannot be abused.
use firewall rules and/or namespaces. This is less error-prone anyway. use firewall rules and/or namespaces. This is less error-prone anyway.
For instance, if you are using the excellent `FireHOL <https://firehol.org/>`_, For instance, if you are using the excellent `FireHOL <https://firehol.org/>`_,
its very easy to create a group on your system and use it as a condition 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 in your firewall rules. You would then run the application server under that
group. group.