mirror of
https://git.0x0.st/mia/0x0.git
synced 2024-12-22 00:01:08 -05:00
Update README
This commit is contained in:
parent
b7c12902da
commit
b5ce94edeb
1 changed files with 8 additions and 32 deletions
40
README.rst
40
README.rst
|
@ -4,6 +4,12 @@ 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>`_.
|
||||
|
||||
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::
|
||||
|
||||
|
@ -11,8 +17,7 @@ To make it work, include this in your nginx config’s ``server`` block::
|
|||
internal;
|
||||
}
|
||||
|
||||
where ``/up`` is whatever you’ve configured as ``FHOST_STORAGE_PATH``
|
||||
in ``fhost.py``.
|
||||
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.
|
||||
|
@ -22,7 +27,7 @@ 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 ``./fhost.py db upgrade``.
|
||||
Before running the service for the first time, run ``FLASK_APP=fhost flask db upgrade``.
|
||||
|
||||
|
||||
NSFW Detection
|
||||
|
@ -34,32 +39,3 @@ the following:
|
|||
|
||||
* Caffe Python module (built for Python 3)
|
||||
* ``ffmpegthumbnailer`` executable in ``$PATH``
|
||||
|
||||
|
||||
FAQ
|
||||
---
|
||||
|
||||
Q:
|
||||
Will you ever add a web interface with HTML forms?
|
||||
A:
|
||||
No. This would without a doubt make it very popular and quickly exceed
|
||||
my hosting budget unless I started crippling it.
|
||||
|
||||
Q:
|
||||
What about file management? Will I be able to register an account at some
|
||||
point?
|
||||
A:
|
||||
No.
|
||||
|
||||
Q:
|
||||
Why are you storing IP addresses with each uploaded file?
|
||||
A:
|
||||
This is done to make dealing with legal claims and accidental uploads
|
||||
easier, e.g. when a user requests removal of all text files uploaded from
|
||||
a certain address within a given time frame (it happens).
|
||||
|
||||
Q:
|
||||
Do you accept donations?
|
||||
A:
|
||||
Only if you insist. I’ve spent very little time and effort on this service
|
||||
and I don’t feel like I should be taking money for it.
|
||||
|
|
Loading…
Reference in a new issue