{"id":9172,"date":"2024-08-30T14:24:09","date_gmt":"2024-08-30T14:24:09","guid":{"rendered":"https:\/\/www.webhi.com\/how-to\/?p=9172"},"modified":"2024-08-30T14:24:11","modified_gmt":"2024-08-30T14:24:11","slug":"deploying-flask-application-with-gunicorn-nginx-ubuntu","status":"publish","type":"post","link":"https:\/\/www.webhi.com\/how-to\/deploying-flask-application-with-gunicorn-nginx-ubuntu\/","title":{"rendered":"Deploying a Flask Application with Gunicorn and Nginx on Ubuntu"},"content":{"rendered":"\n
\"Deploy<\/figure>\n\n\n\n

Deploying a Flask application is a critical step in making your web application accessible to the world. While Flask comes with a built-in development server, it’s not suitable for production. For a robust, scalable, and production-ready setup, you\u2019ll need a combination of Gunicorn, Nginx, and Ubuntu. This guide will walk you through the process of deploying your Flask application with Gunicorn and Nginx on an Ubuntu server.<\/p>\n\n\n\n

Deploying Flask apps on a server might seem challenging if you’re new to backend development, but this comprehensive guide will break down each step. By the end, you’ll have a Flask application up and running on Ubuntu, served by Gunicorn and Nginx.<\/p>\n\n\n\n

Understanding the Deployment Stack: Flask, Gunicorn, and Nginx<\/strong><\/h2>\n\n\n\n

Before diving into the deployment process, it\u2019s important to understand the tools we’ll be using.<\/p>\n\n\n\n

Flask: The Micro Web Framework<\/strong><\/h3>\n\n\n\n

Flask is a lightweight web framework written in Python. It’s designed to be simple, flexible, and easy to get started with, which makes it a popular choice for building web applications. However, Flask’s built-in server is not suitable for production environments because it cannot handle more than one request at a time.<\/p>\n\n\n\n

Gunicorn: The Python WSGI HTTP Server<\/strong><\/h3>\n\n\n\n

Gunicorn (Green Unicorn) is a Python WSGI HTTP server that serves your Flask application. It\u2019s a pre-fork worker model, which means it forks multiple worker processes to handle multiple requests simultaneously. This makes it ideal for serving Flask applications in production. Gunicorn sits between your Flask application and the web server (Nginx in this case), handling the heavy lifting of managing requests and serving responses.<\/p>\n\n\n\n

Nginx: The Web Server and Reverse Proxy<\/strong><\/h3>\n\n\n\n

Nginx is a high-performance web server that also acts as a reverse proxy, load balancer, and HTTP cache. In this setup, Nginx will sit in front of Gunicorn, handling client connections and static content, and then forwarding dynamic requests to Gunicorn. This separation of concerns helps improve security, performance, and scalability.<\/p>\n\n\n\n

Setting Up the Ubuntu Server<\/strong><\/h2>\n\n\n\n

Initial Server Setup<\/strong><\/h3>\n\n\n\n

First, you need access to an Ubuntu server. This could be a physical machine, a virtual machine, or a cloud instance from providers like AWS, DigitalOcean, or Google Cloud Platform.<\/p>\n\n\n\n

    \n
  1. Log in to your server:<\/strong><\/li>\n<\/ol>\n\n\n\n
    $ ssh username@your_server_ip<\/code><\/pre>\n\n\n\n
      \n
    1. Update your package index:<\/strong><\/li>\n<\/ol>\n\n\n\n
      $ sudo apt update<\/code><\/pre>\n\n\n\n
        \n
      1. Upgrade installed packages:<\/strong><\/li>\n<\/ol>\n\n\n\n
        $ sudo apt upgrade<\/code><\/pre>\n\n\n\n
        Installing Necessary Packages<\/strong><\/h3>\n\n\n\n
        You\u2019ll need Python, pip, and virtualenv to run your Flask application.<\/p>\n\n\n\n
          \n
        1. Install Python and pip:<\/strong><\/li>\n<\/ol>\n\n\n\n
          $ sudo apt install python3 python3-pip<\/code><\/pre>\n\n\n\n
            \n
          1. Install virtualenv:<\/strong><\/li>\n<\/ol>\n\n\n\n
            $ sudo pip3 install virtualenv<\/code><\/pre>\n\n\n\n
            Preparing Your Flask Application<\/strong><\/h2>\n\n\n\n
            Creating a Flask Application<\/strong><\/h3>\n\n\n\n
            If you don\u2019t already have a Flask application, you can create a simple one. Here\u2019s an example:<\/p>\n\n\n\n
              \n
            1. Create a directory for your project:<\/strong><\/li>\n<\/ol>\n\n\n\n
              $ mkdir ~\/myflaskapp\n$ cd ~\/myflaskapp<\/code><\/pre>\n\n\n\n
                \n
              1. Create a virtual environment:<\/strong><\/li>\n<\/ol>\n\n\n\n
                $ virtualenv venv<\/code><\/pre>\n\n\n\n
                  \n
                1. Activate the virtual environment:<\/strong><\/li>\n<\/ol>\n\n\n\n
                  $ source venv\/bin\/activate<\/code><\/pre>\n\n\n\n
                    \n
                  1. Install Flask:<\/strong><\/li>\n<\/ol>\n\n\n\n
                    $ pip install Flask<\/code><\/pre>\n\n\n\n
                      \n
                    1. Create a simple Flask application:<\/strong><\/li>\n<\/ol>\n\n\n\n
                      Create a file named app.py<\/code>:<\/p>\n\n\n\n
                      from flask import Flask\n\napp = Flask(__name__)\n\n@app.route('\/')\ndef hello_world():\n      return 'Hello, World!'\n\nif __name__ == '__main__':\n      app.run()<\/code><\/pre>\n\n\n\n
                        \n
                      1. Test your application:<\/strong><\/li>\n<\/ol>\n\n\n\n
                        Run the application to ensure everything works:<\/p>\n\n\n\n
                        $ python app.py<\/code><\/pre>\n\n\n\n
                        You should see output indicating that the Flask development server is running. Visit http:\/\/your_server_ip:5000<\/code> in your browser, and you should see “Hello, World!”<\/p>\n\n\n\n
                        Structuring the Flask Application<\/strong><\/h3>\n\n\n\n
                        In a production environment, it’s good practice to structure your Flask application in a modular way. Here\u2019s a simple example of how you might structure your application:<\/p>\n\n\n\n
                        myflaskapp\/\n\u2502\n\u251c\u2500\u2500 app\/\n\u2502   \u251c\u2500\u2500 __init__.py\n\u2502   \u251c\u2500\u2500 routes.py\n\u2502   \u251c\u2500\u2500 models.py\n\u2502   \u2514\u2500\u2500 templates\/\n\u2502\n\u251c\u2500\u2500 venv\/\n\u251c\u2500\u2500 config.py\n\u251c\u2500\u2500 requirements.txt\n\u2514\u2500\u2500 wsgi.py<\/code><\/pre>\n\n\n\n
                        Creating a WSGI Entry Point<\/strong><\/h3>\n\n\n\n
                        Gunicorn needs a WSGI entry point to serve your Flask application. This is typically a file named wsgi.py<\/code>:<\/p>\n\n\n\n
                          \n
                        1. Create the wsgi.py<\/code> file:<\/strong><\/li>\n<\/ol>\n\n\n\n
                          from app import app\n\nif __name__ == \"__main__\":\n      app.run()<\/code><\/pre>\n\n\n\n
                            \n
                          1. Install additional dependencies:<\/strong><\/li>\n<\/ol>\n\n\n\n
                            If your application has additional dependencies, list them in a requirements.txt<\/code> file and install them:<\/p>\n\n\n\n
                            $ pip freeze > requirements.txt\n$ pip install -r requirements.txt<\/code><\/pre>\n\n\n\n
                            Deploying Flask with Gunicorn<\/strong><\/h2>\n\n\n\n
                            Installing Gunicorn<\/strong><\/h3>\n\n\n\n
                            Gunicorn is a Python package, so it can be installed via pip.<\/p>\n\n\n\n
                              \n
                            1. Install Gunicorn:<\/strong><\/li>\n<\/ol>\n\n\n\n
                              $ pip install gunicorn<\/code><\/pre>\n\n\n\n
                              Running Gunicorn<\/strong><\/h3>\n\n\n\n
                              To test that Gunicorn can serve your application, run the following command:<\/p>\n\n\n\n
                              $ gunicorn --bind 0.0.0.0:8000 wsgi:app<\/code><\/pre>\n\n\n\n
                              This command tells Gunicorn to serve your Flask application using the wsgi.py<\/code> file, binding to port 8000. You should be able to access your application at http:\/\/your_server_ip:8000<\/code>.<\/p>\n\n\n\n
                              Configuring Gunicorn for Production<\/strong><\/h3>\n\n\n\n
                              For production, you typically want to run Gunicorn with several worker processes to handle multiple requests concurrently.<\/p>\n\n\n\n
                                \n
                              1. Create a systemd service file for Gunicorn:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                This allows you to manage Gunicorn with systemd, the init system used by Ubuntu.<\/p>\n\n\n\n
                                $ sudo nano \/etc\/systemd\/system\/gunicorn.service<\/code><\/pre>\n\n\n\n
                                Add the following content:<\/p>\n\n\n\n
                                [Unit]<\/strong>\nDescription=Gunicorn instance to serve myflaskapp\nAfter=network.target\n\n[Service]<\/strong>\nUser=yourusername\nGroup=www-data\nWorkingDirectory=\/home\/yourusername\/myflaskapp\nEnvironment=\"PATH=\/home\/yourusername\/myflaskapp\/venv\/bin\"\nExecStart=\/home\/yourusername\/myflaskapp\/venv\/bin\/gunicorn --workers 3 --bind unix:myflaskapp.sock -m 007 wsgi:app\n\n[Install]<\/strong>\nWantedBy=multi-user.target<\/code><\/pre>\n\n\n\n
                                Replace yourusername<\/code> with your actual username.<\/p>\n\n\n\n
                                  \n
                                1. Start and enable the Gunicorn service:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                  $ sudo systemctl start gunicorn\n$ sudo systemctl enable gunicorn<\/code><\/pre>\n\n\n\n
                                    \n
                                  1. Check the status of the Gunicorn service:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                    $ sudo systemctl status gunicorn<\/code><\/pre>\n\n\n\n
                                    If everything is set up correctly, Gunicorn should be running and serving your Flask application.<\/p>\n\n\n\n
                                    Setting Up Nginx<\/strong><\/h2>\n\n\n\n
                                    Installing Nginx<\/strong><\/h3>\n\n\n\n
                                    If you don’t have Nginx installed, you can install it using the following command:<\/p>\n\n\n\n
                                    $ sudo apt install nginx<\/code><\/pre>\n\n\n\n
                                    Configuring Nginx as a Reverse Proxy<\/strong><\/h3>\n\n\n\n
                                    Nginx will act as a reverse proxy, passing requests to Gunicorn and serving static files directly.<\/p>\n\n\n\n
                                      \n
                                    1. Create a new server block:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                      $ sudo nano \/etc\/nginx\/sites-available\/myflaskapp<\/code><\/pre>\n\n\n\n
                                      Add the following content:<\/p>\n\n\n\n
                                      server<\/strong> {\n      listen 80;\n      server_name your_domain_or_IP;\n\n      location<\/strong> \/ {\n         include proxy_params;\n         proxy_pass http:\/\/unix:\/home\/yourusername\/myflaskapp\/myflaskapp.sock;\n      }\n\n      location<\/strong> \/static\/ {\n         alias \/home\/yourusername\/myflaskapp\/app\/static\/;\n      }\n\n      error_log \/home\/yourusername\/myflaskapp\/error.log;\n      access_log \/home\/yourusername\/myflaskapp\/access.log;\n}<\/code><\/pre>\n\n\n\n
                                      Replace yourusername<\/code> with your actual username and your_domain_or_IP<\/code> with your server’s IP address or domain name.<\/p>\n\n\n\n
                                        \n
                                      1. Enable the new server block:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                        $ sudo ln -s \/etc\/nginx\/sites-available\/myflaskapp \/etc\/nginx\/sites-enabled<\/code><\/pre>\n\n\n\n
                                          \n
                                        1. Test the Nginx configuration:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                          $ sudo nginx -t<\/code><\/pre>\n\n\n\n
                                          If the test is successful, you should see output indicating that the configuration is OK.<\/p>\n\n\n\n
                                            \n
                                          1. Restart Nginx to apply the changes:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                            $ sudo systemctl restart nginx<\/code><\/pre>\n\n\n\n
                                            Allowing Nginx through the Firewall<\/strong><\/h3>\n\n\n\n
                                            If you\u2019re using UFW (Uncomplicated Firewall), you need to allow Nginx through the firewall.<\/p>\n\n\n\n
                                            $ sudo ufw allow 'Nginx Full'<\/code><\/pre>\n\n\n\n
                                            Securing the Application with SSL<\/strong><\/h2>\n\n\n\n
                                            To secure your application, you can set up SSL using Let’s Encrypt.<\/p>\n\n\n\n
                                            Installing Certbot<\/strong><\/h3>\n\n\n\n
                                            Certbot is a tool to automate the process of obtaining and renewing SSL certificates.<\/p>\n\n\n\n
                                              \n
                                            1. Install Certbot and the Nginx plugin:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                              $ sudo apt install certbot python3-certbot-nginx<\/code><\/pre>\n\n\n\n
                                                \n
                                              1. Obtain an SSL certificate:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                                Run the following command, replacing your_domain_or_IP<\/code> with your domain or IP address:<\/p>\n\n\n\n
                                                $ sudo certbot --nginx -d your_domain_or_IP<\/code><\/pre>\n\n\n\n
                                                  \n
                                                1. Verify SSL certificate renewal:<\/strong><\/li>\n<\/ol>\n\n\n\n
                                                  Certbot will automatically renew your SSL certificates. You can simulate a renewal to check if it’s working:<\/p>\n\n\n\n
                                                  $ sudo certbot renew --dry-run<\/code><\/pre>\n\n\n\n
                                                  Monitoring and Logging<\/strong><\/h2>\n\n\n\n
                                                  Gunicorn Logs<\/strong><\/h3>\n\n\n\n
                                                  Gunicorn will log its output to the systemd journal. To view the logs:<\/p>\n\n\n\n
                                                  $ sudo journalctl -u gunicorn<\/code><\/pre>\n\n\n\n
                                                  Nginx Logs<\/strong><\/h3>\n\n\n\n
                                                  Nginx logs requests and errors to log files in \/var\/log\/nginx\/<\/code>. You can view them with:<\/p>\n\n\n\n
                                                  $ sudo tail -f \/var\/log\/nginx\/access.log\n$ sudo tail -f \/var\/log\/nginx\/error.log<\/code><\/pre>\n\n\n\n
                                                  Troubleshooting Common Issues<\/strong><\/h2>\n\n\n\n
                                                  Gunicorn Fails to Start<\/strong><\/h3>\n\n\n\n