Ubuntu

Deploy your application with uWSGI and Nginx on Ubuntu

Ubuntu is a GNU/Linux operating system that can run the Web Application Server uWSGI and the Web Server Nginx.

For Ubuntu version before 20.04

Before Ubuntu 20.04, the pre-installed Python version is older than Python 3.8 which is the oldest Python version supported by Taipy. If you are in that case, please install Python 3.8 (or newer).

Prepare your machine

The following software should be installed on your target machine:

• pip: for installing Python3 packages.

• uwsgi and gevent: the Web application server and its workers that will run the Taipy application.

• nginx: the Web server for the Internet exposition.

You can install all of these packages by running the following command:

sudo apt update -y
sudo apt install -y python3-pip nginx
sudo pip install uwsgi gevent
sudo ln -s `pwd`/.local/bin/uwsgi /usr/bin/uwsgi

Note

If you are using an SQL database based on Microsoft SQL Server, you need to install your corresponding Microsoft ODBC Driver for SQL Server.

Run the application locally

If you want to deploy the following application:

from taipy import Gui

Gui(page="# Getting started with *Taipy*").run()

This would be placed in a file called app.py.
You need to create a requirements.txt file that contains:

taipy

On your local machine, start the application by doing:

$pip install -r requirements.txt
Collecting taipy
<-- Truncate -->
Successfully installed taipy
$python app.py
 * Server starting on http://127.0.0.1:5000
 * Serving Flask app 'Taipy' (lazy loading)
 * Environment: production
   WARNING: This is a development server. Do not use it in a production deployment.
   Use a production WSGI server instead.
 * Debug mode: on
<-- Truncate -->

The application is running locally, you can access it with the browser on the URL http://127.0.0.1:5000/.

Note

The message:

WARNING: This is a development server. Do not use it in a production deployment.
Use a production WSGI server instead.

Is provided by Flask because the way of exposing an application on the Internet and developping an application locally is not the same, mainly for security and reliability reasons. This message will disappear when using the Web server.

Prepare the application for deployment

Deploying your application to a remote environment needs a little bit of configuration.

By default, Taipy applications run in Debug mode. Before deploying your application to the Internet, you should turn off the Debug mode by setting the debug parameter or the run() to False.
You must also inform Taipy not to run the application server on its own but rather delegate the execution by setting the parameter run_server to False.
The name of the variable where the Web application is stored is used in the uWSGI configuration: this allows the Web server to load the Web application:

from taipy import Gui

gui_service = Gui(page="# Getting started with *Taipy*")
web_app = gui_service.run(debug=False, run_server=False)

In our example, we store this application in the variable web_app (see line 3)

Make sure you upload this code on your targeted machine and install your dependencies with pip.

Important

The entry point filename and the app variable name are important for the proper configuration of the uWSGI Web application server. Please, keep them as is or adapt the configuration.

uWSGI application server

To expose your application over the Internet, you must use uWSGI instead of Flask as the application server. You would then leverage Nginx to expose the application.

uWSGI can be started manually. But, generally, it's better to start the application automatically when the machine starts. To order to do that, you should use Systemd which is installed by default on Ubuntu.

From the directory where app.py is located, run the following command to generate an adapted file for Systemd:

echo """
[Unit]
Description=App
After=syslog.target

[Service]
ExecStart=uwsgi --http 127.0.0.1:5000 --gevent 1000 --http-websockets --module app:web_app
WorkingDirectory=`pwd`
Restart=always
KillSignal=SIGQUIT
Type=notify
StandardError=syslog
NotifyAccess=all
User=`whoami`

[Install]
WantedBy=multi-user.target
""" > app.uwsgi.service

Then transfer this file in the correct folder by doing:

sudo mv app.uwsgi.service /etc/systemd/system/app.uwsgi.service

Now, you can start your application automatically on startup time of your machine by doing:

sudo systemctl start app.uwsgi.service
sudo systemctl enable app.uwsgi.service

The application is now running locally but is not accessible yet from the Internet.

Exposing to the Internet

To expose your application on the Internet, you should use Nginx. Change the content of /etc/nginx/sites-enabled/default with the following:

server {
    listen 80;
    location / {
        proxy_pass http://localhost:5000;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Host $host;
    }
}

Then restart Nginx:

sudo systemctl restart nginx

Your application is now accessible over the Internet!

Note

This configuration is only for HTTP. If you need an HTTPS connection, please read the Nginx documentation.