fix: readme

master
Tim 9 months ago
parent a84d2e50e4
commit 8aa0897d7d

@ -1,16 +1,16 @@
The Null Pointer
================
The First Pointer
=================
This is a no-bullshit file hosting and URL shortening service that also runs
`0x0.st <https://0x0.st>`_. Use with uWSGI.
This is a no-bullshit file hosting service that also runs
`0x1a.ro <https://0x1a.ro>`_, which was forked from the wonderful `0x0.st <https://0x0.st>`
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 change settings, copy ``config.py.example`` to ``instance/config.py`` and modify to your liking.
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
To customize the home and error pages, 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.
@ -32,6 +32,25 @@ now and then.
Before running the service for the first time, run ``FLASK_APP=fhost flask db upgrade``.
Docker Build & Run
------------------
block::
docker build . -t 0x1a:latest
Then run with Docker-Compose block::
version: "3"
services:
"0x1a":
image: 0x1a:latest
container_name: "0x1a"
volumes:
- ./upload:/files
- ./instance:/python-docker/instance
- ./fhost_db.sql:/python-docker/fhost_db.sql
NSFW Detection
--------------

@ -46,7 +46,7 @@ If you run a server and like this site, clone it! Centralization is bad.
https://git.0x0.st/mia/0x0
You can also support it financially via libreapay.
<img src="https://img.shields.io/liberapay/receives/~1788687.svg?logo=liberapay">
<img src="https://img.shields.io/liberapay/receives/0x1a.svg?logo=liberapay">
Initial hosting costs about 20 AUD a month currently, and I expect it to scale with time to 50 AUD a month
If you wish to make just a small one-time donation, that is cool too!

Loading…
Cancel
Save