imgupload-legacy/README.md

imgupload

What is imgupload?

imgupload is a Flask + uWSGI application to serve as an all-purpose image/file uploader over POST requests.

---

FAQ

Where can I send bug reports and feature requests?

You can create an issue here.

How do I use this program?

See Installation

I want to make a pull request. Where should I do that?

First, fork this repository. If you don't have an account on my Gitea site yet, you can either create one, or sign in using your GitHub account. Commit your changes to your fork, and then create a pull request.

---

Installation

Using uWSGI

Note: replace www-data with whatever user your webserver runs as.

1. Make /srv/imgupload: sudo mkdir /srv/imgupload
2. Change ownership of /srv/imgupload: sudo chown www-data:www-data /srv/imgupload
3. Enter www-data user: sudo su www-data
4. Change directories to /srv/imgupload: cd /srv/imgupload
5. Clone the repository: git clone https://git.bbaovanc.com/bbaovanc/imgupload.git
6. Enter the imgupload directory: cd imgupload
7. Create a virtualenv: python3 -m venv env
8. Enter the virtualenv: source env/bin/activate
9. Install dependencies: python3 -m pip install -r requirements.txt
10. Leave the www-data user: exit
11. Copy the default uWSGI configuration: sudo cp /srv/imgupload/uwsgi.ini.default /etc/uwsgi/apps-available/imgupload.ini
12. Modify /etc/uwsgi/apps-available/imgupload.ini to your preferences
13. Enable imgupload: sudo ln -s /etc/uwsgi/apps-available/imgupload.ini /etc/uwsgi/apps-enabled/
14. Restart uWSGI: sudo systemctl restart uwsgi
15. Set up your webserver to proxy the uwsgi.sock

Example NGINX location block:

location /upload {
    include uwsgi_params;
    uwsgi_pass unix:/srv/imgupload/uwsgi.sock;
    client_max_body_size 25M;
}

Using Flask development server

Setup

$ git clone https://git.bbaovanc.com/bbaovanc/imgupload.git
$ cd imgupload
$ python3 -m venv env
$ source env/bin/activate
$ pip3 install -r requirements.txt

Run

$ export FLASK_APP=imgupload.py
$ flask run

---

License

imgupload is licensed under the GPLv3 license. For more information, please refer to LICENSE