Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update examples #7

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ Clone and install::
sudo mv xmpp-http-upload /opt/xmpp-http-upload
cd /opt/xmpp-http-upload
copy config.example.py config.py
sudo apt-get install python3-flask
sudo apt-get install python3-pip
sudo python3 -m pip install --upgrade flask-cors
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer to not recommend installing flask from pip. flask-cors is still optional for that reason.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So just keep the uwsgi examples and my updated nginx conf ? Is there a better way than to create a new branch, cherry pick, submit a new pr and abandon this one ?


Edit ``config.py`` and change ``SECRET_KEY``. Be sure to only change between ``''``.

Expand All @@ -87,4 +88,4 @@ Enable systemd service::
Configure your webserver:

As final step you need to point your external webserver to your xmpp-http-upload flask app.
Check the ``contrib`` directory, there is an example for nginx there.
Check the ``contrib`` directory, there is an example for nginx there.
12 changes: 12 additions & 0 deletions contrib/nginx-example-uwsgi.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Include this snippet in your nginx config.
# Make sure to preserve the trailing slashes if you change the location.
# Use this if you want to serve uploads from a subdirectory. The break statement
# is needed to remove the subdirectory when making the upstream request.

location /upload/ {
rewrite ^/upload/(.*) /$1 break;
include uwsgi_params;
uwsgi_pass uwsgi://localhost:9002;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
client_max_body_size 100M;
}
3 changes: 3 additions & 0 deletions contrib/nginx-example.conf
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# Include this snippet in your nginx config.
# Make sure to preserve the trailing slashes if you change the location.
# Use this if you want to serve uploads from a subdirectory. The break statement
# is needed to remove the subdirectory when making the upstream request.

location /upload/ {
rewrite ^/upload/(.*) /$1 break;
proxy_pass http://localhost:5000/;
client_max_body_size 100M;
}
19 changes: 19 additions & 0 deletions contrib/xmpp-http-upload.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Example ini for uwsgi usage. Adapt uid/gid to whatever user your webserver uses.
# This must also align with your directory permissions.
# env must point to your xhu config file.

[uwsgi]
socket = 0.0.0.0:9002
processes = 5
threads = 1
auto-procname = true
procname-prefix-spaced = [xmpp-http-upload]
uid = www-data
gid = www-data
need-plugin = python3
chdir = /opt/xmpp-http-upload/
pythonpath = /opt/xmpp-http-upload/
wsgi-file = /opt/xmpp-http-upload/xhu.py
enable-threads = true
offload-threads = 10
env = XMPP_HTTP_UPLOAD_CONFIG=/opt/xmpp-http-upload/config.yml
2 changes: 1 addition & 1 deletion contrib/xmpp-http-upload.service
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Group=www-data

Environment=FLASK_APP=/opt/xmpp-http-upload/xhu.py
Environment=XMPP_HTTP_UPLOAD_CONFIG=/opt/xmpp-http-upload/config.py
ExecStart=/usr/bin/flask run
ExecStart=/usr/local/bin/flask run

Restart=on-failure
RestartSec=10
Expand Down