update README

This commit is contained in:
Trent Palmer 2021-01-08 20:43:20 -08:00
parent 77cf2519b2
commit cae9a3636f
1 changed files with 26 additions and 3 deletions

View File

@ -1,6 +1,22 @@
This application allows you to upload photos, where are then automatically
scaled down, using python3-pillow, and saved into an adjacent directory
which is served from a different subdomain.
There is also dashboard functionality, showing you information about the photos
such as size-on-disc, and exif data such as gps coordinates.
## features
* upload, download, delete, photos
* automatically scales down photos
* 2fa with authenticator app
* XMPP error logging
* separate static subdomain for hosting the photos
* dashboard with photo stats
## deploy ## deploy
works on Debian 10 using only distro python3 packages works on Debian 10 using only distro python3 packages, examples for
deployment in the examples directory
## apache configs ## apache configs
@ -14,8 +30,8 @@ outside of the flask app
## dns ## dns
login to your dns provider and add A and AAAA records for photo_app.example.com login to your dns provider and add A and AAAA records for **photo_app.example.com**
and add A and AAA records for photos.example.com and add A and AAAA records for **photos.example.com**
or for LAN testing or deployment, if you are running dnsmasq on your router, you or for LAN testing or deployment, if you are running dnsmasq on your router, you
can add something like the following to the `/etc/hosts` file, and then restart can add something like the following to the `/etc/hosts` file, and then restart
@ -28,3 +44,10 @@ dnsmasq
## email white list ## email white list
in order to register, login to the psql command line and insert in order to register, login to the psql command line and insert
your email address into the email_white_list table your email address into the email_white_list table
## error logging
The configured logging handler in `__init__.py` requires setting up some
xmpp accounts, i.e. setting up an Prosody server.
If this isn't possible, you could use a different logging handler,
such as SMTPHandler, or just look in the systemd-journal.