UWSGI: Difference between revisions
Davezerave (talk | contribs) (Listing all available plugins. Moving the alternatives to the introduction part. Removing useless information about C being faster than Python.) |
Davezerave (talk | contribs) (Extended configuration. Cleaned up 'running uwsgi' and 'nginx (in chroot)'. Added useful help links and 'Tips and tricks' on hardening and proper socket activation.) |
||
Line 22: | Line 22: | ||
* {{Pkg|uwsgi-plugin-webdav}} for [[WebDAV]] support | * {{Pkg|uwsgi-plugin-webdav}} for [[WebDAV]] support | ||
== | == Configuration == | ||
Web applications (e.g. [[Wordpress]], [[ownCloud]], [[Mailman]], [[cgit]]) served by uWSGI are configured in {{ic|/etc/uwsgi/}}, where each of them requires its own configuration file (ini-style). Details can be found [http://uwsgi-docs.readthedocs.org/en/latest/ in the uWSGI documentation]. | |||
{{ | Alternatively, you can run uWSGI in [http://uwsgi-docs.readthedocs.org/en/latest/Emperor.html Emperor mode] (configured in {{ic|/etc/uwsgi/emperor.ini}}). It enables a single uWSGI instance to run a set of different apps (called vassals) using a single main supervisor (called emperor). | ||
=== Web applications === | |||
uWSGI supports many different languages and thus also many web applications. | |||
As an example the configuration file {{ic|/etc/uwsgi/example.ini}} and the prior installation of the plugin needed for your web application is assumed. | |||
For further common configuration examples, have a look at this [https://sleepmap.de/2016/securely-serving-webapps-using-uwsgi/ blog post]. | |||
==== Python ==== | |||
The following is a simple example for a [[Python]] application. | |||
== | |||
The following is a simple example | |||
{{hc|/etc/uwsgi/example.ini|<nowiki> | |||
[uwsgi] | [uwsgi] | ||
chdir = /srv/http/ | chdir = /srv/http/example | ||
module = | module = example | ||
plugins = python | plugins = python | ||
</nowiki>}} | |||
It is also possible to run uWSGI separately with the following syntax for instance: | It is also possible to run uWSGI separately with the following syntax for instance: | ||
Line 65: | Line 52: | ||
{{Note|You should avoid running this command as root}} | {{Note|You should avoid running this command as root}} | ||
==== Php | ==== Php ==== | ||
The following is a simple example for a [[PHP]] based website. | |||
{{hc|/etc/uwsgi/ | {{hc|/etc/uwsgi/example.ini|<nowiki> | ||
[uwsgi] | [uwsgi] | ||
; maximum number of worker processes | ; maximum number of worker processes | ||
Line 87: | Line 74: | ||
</nowiki>}} | </nowiki>}} | ||
=== Web server === | |||
uWSGI can be the backend to many web servers, that support the forwarding of access. The following are examples for configurations. | |||
==== Nginx ==== | |||
[[nginx]] can redirect access towards unix sockets or ports (on localhost or remote machine), depending on your web application. | |||
{{hc|/etc/nginx/example.conf|<nowiki> | |||
# ... | |||
# forward all access to / towards | |||
location / { | |||
root /usr/share/nginx/html; | |||
index index.html index.htm; | |||
include uwsgi_params; | |||
# this is the correct uwsgi_modifier1 parameter for a php based application | |||
uwsgi_modifier1 14; | |||
# uncomment the following if you want to use the unix socket instead | |||
# uwsgi_pass unix:/var/run/uwsgi/example.sock; | |||
# access is redirected to localhost:3031 | |||
uwsgi_pass 127.0.0.1:3031; | |||
} | |||
# ... | |||
</nowiki>}} | |||
{{Tip|Have a look at [https://uwsgi-docs.readthedocs.io/en/latest/Protocol.html#packet-descriptions the documentation] for the list of {{ic|uwsgi_modifier1}} parameters fitting to your web application.}} | |||
==== Nginx | ==== Nginx (in chroot) ==== | ||
{{Note|Please refer to the below tips if you have deployed Nginx as described here: [[Nginx#Installation in a chroot]]}} | {{Note|Please refer to the below tips if you have deployed Nginx as described here: [[Nginx#Installation in a chroot]]}} | ||
Line 158: | Line 154: | ||
{{Note|PID file will be created within {{ic|/run}} rather than {{ic|/srv/http/run}}}} | {{Note|PID file will be created within {{ic|/run}} rather than {{ic|/srv/http/run}}}} | ||
After modification make sure to [[reload]] to incorporate the new or changed units. | |||
You are then free to [[enable]] and [[start]] {{ic|uwsgi@application1.service}}. | |||
Edit {{ic|/srv/http/etc/nginx/nginx.conf}} and add new {{ic|server}} section within it that would contain at least following: | Edit {{ic|/srv/http/etc/nginx/nginx.conf}} and add new {{ic|server}} section within it that would contain at least following: | ||
Line 190: | Line 181: | ||
</nowiki>}} | </nowiki>}} | ||
Make sure to now [[restart]] {{ic|nginx.service}} to have your {{ic|application1}} be served at {{ic|127.0.0.1}}. | |||
== Running uWSGI == | |||
{{Note| This assumes the used web application has been properly configured, is being served by your web server, which redirects towards the socket or port it is using and was configured in {{ic|/etc/uwsgi/}}.}} | |||
If you plan on using a web application all the time (without it being activated on demand), you can simply [[start]] and [[enable]] {{ic|uwsgi@example}}. | |||
If you plan on having your web application be started on demand you can [[start]] and [[enable]] {{ic|uwsgi@example.socket}}. | |||
To use the Emperor mode, [[start]] and [[enable]] {{ic|emperor.uwsgi.service}}. | |||
To use socket activation of this mode [[start]] and [[enable]] {{ic|emperor.uwsgi.socket}}. | |||
== Tips and tricks == | |||
Some functionality, that uWSGI offers is not accessible by using the [[systemd]] service files provided in the [[official repositories]]. | |||
Changes to them are explained in the following sections. For further information about this, [https://sleepmap.de/2016/securely-serving-webapps-using-uwsgi/ read this blog post]. | |||
=== Socket activation === | |||
Using socket activation, you want to | |||
* direct your web server to a unix socket and thereby start your uWSGI instance running the application | |||
* you most likely want to have the application be closed by uWSGI after a certain idle time | |||
* you want your web server be able to start the application again, once it is accessed | |||
uWSGI offers settings, with which you can have the instance close the application: | |||
{{hc|/etc/uwsgi/example.ini|<nowiki> | |||
[uwsgi] | |||
# ... | |||
# set idle time in seconds | |||
idle = 600 | |||
# kill the application after idle time was reached | |||
kill-on-idle = true | |||
# ... | |||
</nowiki>}} | |||
The current {{ic|uwsgi@.service}} file however doesn't allow this, because [[systemd]] treats non-zero exit codes as failure and thereby marking the unit as failed and additionally the {{ic|1=Restart=always}} directive makes a closing after idle time useless. | |||
A fix for this is to add the exit codes, that uWSGI may provide after closing an application by itself to a list, that [[systemd]] will treat as success by using the {{ic|SuccessExitStatus}} directive (for further information [https://sleepmap.de/2016/securely-serving-webapps-using-uwsgi/ read this blog post]) | |||
{{hc|/etc/systemd/system/uwsgi-socket@.service|<nowiki> | |||
[Unit] | |||
Description=uWSGI service unit | |||
After=syslog.target | |||
[Service] | |||
ExecStart=/usr/bin/uwsgi --ini /etc/uwsgi/%I.ini | |||
ExecReload=/bin/kill -HUP $MAINPID | |||
ExecStop=/bin/kill -INT $MAINPID | |||
Type=notify | |||
SuccessExitStatus=15 17 29 30 | |||
StandardError=syslog | |||
NotifyAccess=all | |||
KillSignal=SIGQUIT | |||
[Install] | |||
WantedBy=multi-user.target | |||
</nowiki>}} | |||
This will allow for proper socket activation with kill-after-idle functionality. | |||
=== Hardening uWSGI === | |||
Web applications are exposed to the wild and depending on their quality and the security of their underlying languages, some are more dangerous to run, than others. | |||
A good way to start dealing with possible unsafe web applications is to jail them. [[systemd]] has some functionality, that can be put to use. | |||
Have a look at the following example (and for further information read the [https://www.freedesktop.org/software/systemd/man/systemd.exec.html systemd.exec manual] and [https://sleepmap.de/2016/securely-serving-webapps-using-uwsgi/ this blog post]): | |||
{{hc|/etc/systemd/system/uwsgi-secure@.service|<nowiki> | |||
[Unit] | |||
Description=uWSGI service unit | |||
After=syslog.target | |||
[Service] | |||
ExecStart=/usr/bin/uwsgi --ini /etc/uwsgi/%I.ini | |||
ExecReload=/bin/kill -HUP $MAINPID | |||
ExecStop=/bin/kill -INT $MAINPID | |||
Type=notify | |||
SuccessExitStatus=15 17 29 30 | |||
StandardError=syslog | |||
NotifyAccess=all | |||
KillSignal=SIGQUIT | |||
PrivateDevices=yes | |||
PrivateTmp=yes | |||
ProtectSystem=full | |||
ReadWriteDirectories=/etc/webapps /var/lib/ | |||
ProtectHome=yes | |||
NoNewPrivileges=yes | |||
[Install] | |||
WantedBy=multi-user.target | |||
</nowiki>}} | |||
{{Note| Using {{ic|1=NoNewPrivileges=yes}} doesn't work with [[Mailman]]'s cgi frontend! Remove this setting, if you want to use it in conjunction with it.}} | |||
== See Also == | == See Also == | ||
* [http://uwsgi-docs.readthedocs.org/en/latest Official Documentation] | * [http://uwsgi-docs.readthedocs.org/en/latest Official Documentation] | ||
* [https://github.com/unbit/uwsgi-docs uWSGI Github] | * [https://github.com/unbit/uwsgi-docs uWSGI Github] | ||
* [https://sleepmap.de/2016/securely-serving-webapps-using-uwsgi/ Securely serving webapps using uWSGI] | |||
* [http://blog.kgriffs.com/ Fluffy White Stuff Benchmark] | * [http://blog.kgriffs.com/ Fluffy White Stuff Benchmark] | ||
* [http://flask.pocoo.org/docs/deploying/uwsgi/ Flask uWSGI deploying] | * [http://flask.pocoo.org/docs/deploying/uwsgi/ Flask uWSGI deploying] |
Revision as of 18:51, 8 October 2016
uWSGI is a fast, self-healing and developer/sysadmin-friendly application container server coded in pure C.
There are alternatives written in Python such as gunicornAUR.
Installation
Install the package uwsgi from the official repositories. Note, that the package does not come with plugins. They have to be installed separately:
- uwsgi-plugin-cgi for CGI support
- uwsgi-plugin-jvm for Java support
- uwsgi-plugin-lua51 for Lua support
- uwsgi-plugin-mono for Mono support
- uwsgi-plugin-php for PHP support
- uwsgi-plugin-psgi for Perl support
- uwsgi-plugin-pypy for PyPy support
- uwsgi-plugin-python for Python support
- uwsgi-plugin-python2 for Python2 support
- uwsgi-plugin-rack for Ruby Rack support
- uwsgi-plugin-webdav for WebDAV support
Configuration
Web applications (e.g. Wordpress, ownCloud, Mailman, cgit) served by uWSGI are configured in /etc/uwsgi/
, where each of them requires its own configuration file (ini-style). Details can be found in the uWSGI documentation.
Alternatively, you can run uWSGI in Emperor mode (configured in /etc/uwsgi/emperor.ini
). It enables a single uWSGI instance to run a set of different apps (called vassals) using a single main supervisor (called emperor).
Web applications
uWSGI supports many different languages and thus also many web applications.
As an example the configuration file /etc/uwsgi/example.ini
and the prior installation of the plugin needed for your web application is assumed.
For further common configuration examples, have a look at this blog post.
Python
The following is a simple example for a Python application.
/etc/uwsgi/example.ini
[uwsgi] chdir = /srv/http/example module = example plugins = python
It is also possible to run uWSGI separately with the following syntax for instance:
uwsgi --socket 127.0.0.1:3031 --plugin python2 --wsgi-file ~/foo.py --master --processes 4 --threads 2 --stats 127.0.0.1:9191 --uid --gid
Php
The following is a simple example for a PHP based website.
/etc/uwsgi/example.ini
[uwsgi] ; maximum number of worker processes processes = 4 ; the user and group id of the process once it’s started uid = http gid = http socket = /run/uwsgi/%n.sock master = true chdir = /srv/http/%n ; php plugins = php ; jail our php environment php-docroot = /srv/http/%n php-index = index.php ; clear environment on exit vacuum = true
Web server
uWSGI can be the backend to many web servers, that support the forwarding of access. The following are examples for configurations.
Nginx
nginx can redirect access towards unix sockets or ports (on localhost or remote machine), depending on your web application.
/etc/nginx/example.conf
# ... # forward all access to / towards location / { root /usr/share/nginx/html; index index.html index.htm; include uwsgi_params; # this is the correct uwsgi_modifier1 parameter for a php based application uwsgi_modifier1 14; # uncomment the following if you want to use the unix socket instead # uwsgi_pass unix:/var/run/uwsgi/example.sock; # access is redirected to localhost:3031 uwsgi_pass 127.0.0.1:3031; } # ...
uwsgi_modifier1
parameters fitting to your web application.Nginx (in chroot)
/srv/http
First create ini file that will point to your application:
/etc/uwsgi/application1.ini
[uwsgi] chroot = /srv/http chdir = /www/application1 wsgi-file = application1.py plugins = python socket = /run/application1.sock uid = http gid = http threads = 2 stats = 127.0.0.1:9191 vacuum = true
Since we are chrooting to /srv/http
above configuration will result in following unix socket being created /srv/http/run/application1.sock
/srv/http/www/application1
before service is started. Depending on configuration your application may be cached so you may need to restart the service when you modify it/lib/python3.4
to /srv/http/lib/python3.4
You can try to run following:
# cp -r -p /lib/python3.4 /srv/http/lib # cp -r -p /lib/*python*so /srv/http/lib
You will need to disable notifications within your service file:
/etc/systemd/system/multi-user.target.wants/uwsgi\@application1.service
[Unit] Description=uWSGI service unit After=syslog.target [Service] PIDFile=/run/%I.pid RemainAfterExit=yes ExecStart=/usr/bin/uwsgi --ini /etc/uwsgi/%I.ini ExecReload=/bin/kill -HUP $MAINPID ExecStop=/bin/kill -INT $MAINPID Restart=always StandardError=syslog KillSignal=SIGQUIT [Install] WantedBy=multi-user.target
/run
rather than /srv/http/run
After modification make sure to reload to incorporate the new or changed units.
You are then free to enable and start uwsgi@application1.service
.
Edit /srv/http/etc/nginx/nginx.conf
and add new server
section within it that would contain at least following:
/srv/http/etc/nginx/nginx.conf
... server { listen 80; server_name 127.0.0.1; location / { root /www/application1; include uwsgi_params; uwsgi_pass unix:/run/application1.sock; } error_page 500 502 503 504 /50x.html; location = /50x.html { root /usr/share/nginx/html; } } ...
Make sure to now restart nginx.service
to have your application1
be served at 127.0.0.1
.
Running uWSGI
/etc/uwsgi/
.If you plan on using a web application all the time (without it being activated on demand), you can simply start and enable uwsgi@example
.
If you plan on having your web application be started on demand you can start and enable uwsgi@example.socket
.
To use the Emperor mode, start and enable emperor.uwsgi.service
.
To use socket activation of this mode start and enable emperor.uwsgi.socket
.
Tips and tricks
Some functionality, that uWSGI offers is not accessible by using the systemd service files provided in the official repositories. Changes to them are explained in the following sections. For further information about this, read this blog post.
Socket activation
Using socket activation, you want to
- direct your web server to a unix socket and thereby start your uWSGI instance running the application
- you most likely want to have the application be closed by uWSGI after a certain idle time
- you want your web server be able to start the application again, once it is accessed
uWSGI offers settings, with which you can have the instance close the application:
/etc/uwsgi/example.ini
[uwsgi] # ... # set idle time in seconds idle = 600 # kill the application after idle time was reached kill-on-idle = true # ...
The current uwsgi@.service
file however doesn't allow this, because systemd treats non-zero exit codes as failure and thereby marking the unit as failed and additionally the Restart=always
directive makes a closing after idle time useless.
A fix for this is to add the exit codes, that uWSGI may provide after closing an application by itself to a list, that systemd will treat as success by using the SuccessExitStatus
directive (for further information read this blog post)
/etc/systemd/system/uwsgi-socket@.service
[Unit] Description=uWSGI service unit After=syslog.target [Service] ExecStart=/usr/bin/uwsgi --ini /etc/uwsgi/%I.ini ExecReload=/bin/kill -HUP $MAINPID ExecStop=/bin/kill -INT $MAINPID Type=notify SuccessExitStatus=15 17 29 30 StandardError=syslog NotifyAccess=all KillSignal=SIGQUIT [Install] WantedBy=multi-user.target
This will allow for proper socket activation with kill-after-idle functionality.
Hardening uWSGI
Web applications are exposed to the wild and depending on their quality and the security of their underlying languages, some are more dangerous to run, than others. A good way to start dealing with possible unsafe web applications is to jail them. systemd has some functionality, that can be put to use. Have a look at the following example (and for further information read the systemd.exec manual and this blog post):
/etc/systemd/system/uwsgi-secure@.service
[Unit] Description=uWSGI service unit After=syslog.target [Service] ExecStart=/usr/bin/uwsgi --ini /etc/uwsgi/%I.ini ExecReload=/bin/kill -HUP $MAINPID ExecStop=/bin/kill -INT $MAINPID Type=notify SuccessExitStatus=15 17 29 30 StandardError=syslog NotifyAccess=all KillSignal=SIGQUIT PrivateDevices=yes PrivateTmp=yes ProtectSystem=full ReadWriteDirectories=/etc/webapps /var/lib/ ProtectHome=yes NoNewPrivileges=yes [Install] WantedBy=multi-user.target
NoNewPrivileges=yes
doesn't work with Mailman's cgi frontend! Remove this setting, if you want to use it in conjunction with it.