Ubuntu 18.04에서 Gunicorn 및 Nginx로 Flask 애플리케이션을 제공하는 방법

소개

이 가이드에서는 Ubuntu 18.04에서 Flask 마이크로프레임워크를 사용하여 Python 애플리케이션을 빌드합니다. 이 기사의 대부분은 프런트 엔드 리버스 프록시로 작동하도록 Nginx를 설정하는 방법에 관한 것입니다.

전제 조건

이 자습서를 완료하려면 다음이 필요합니다.

Ubuntu 18.04가 설치된 서버, sudo 권한이 있는 루트가 아닌 사용자, 방화벽이 활성화된 서버. 지침은 초기 서버 설정 가이드를 따르십시오.
Ubuntu 18.04에 Nginx를 설치하는 방법의 1단계와 2단계에 따라 Nginx가 설치되었습니다.\n
서버를 가리키도록 구성된 도메인 이름. 도메인 및 DNS에 대한 문서에서 구매할 수 있습니다. 다음 DNS 레코드를 생성해야 합니다.\n
- 서버의 공용 IP 주소를 가리키는 your_domain이 있는 A 레코드
- 서버의 공개 IP 주소를 가리키는 www.your_domain이 있는 A 레코드
Gunicorn 서버가 Flask 애플리케이션과 통신하는 데 사용할 WSGI 사양에 익숙합니다. 이 토론에서는 WSGI에 대해 자세히 다룹니다.
1단계 — Ubuntu 리포지토리에서 구성 요소 설치
첫 번째 단계는 기본 Ubuntu 리포지토리에서 필요한 모든 패키지를 설치하는 것입니다. 여기에는 Python 구성 요소를 관리할 Python 패키지 관리자인 pip가 포함됩니다. Gunicorn 구성 요소 중 일부를 빌드하는 데 필요한 Python 개발 파일도 얻을 수 있습니다.

먼저 로컬 패키지를 업데이트합니다.
```
sudo apt update
```
그런 다음 Python 환경을 구축할 수 있는 패키지를 설치합니다. 여기에는 강력한 프로그래밍 환경에 필요한 몇 가지 추가 패키지 및 개발 도구와 함께 python3-pip가 포함됩니다.
```
sudo apt install python3-pip python3-dev build-essential libssl-dev libffi-dev python3-setuptools
```
이러한 패키지가 준비되면 프로젝트를 위한 가상 환경 생성으로 이동합니다.
2단계 — Python 가상 환경 만들기
다음으로 Flask 애플리케이션을 시스템의 다른 Python 파일과 격리하도록 가상 환경을 설정합니다.
venv 모듈을 설치할 python3-venv 패키지를 설치하여 시작합니다.
```
sudo apt install python3-venv
```
다음으로 Flask 프로젝트의 상위 디렉터리를 만듭니다.
```
mkdir ~/myproject
```
그런 다음 디렉터리를 만든 후 디렉터리로 변경합니다.
```
cd ~/myproject
```
다음을 입력하여 Flask 프로젝트의 Python 요구 사항을 저장할 가상 환경을 만듭니다.
```
python3.6 -m venv myprojectenv
```
이렇게 하면 프로젝트 디렉터리 내의 myprojectenv라는 디렉터리에 Python 및 pip의 로컬 복사본이 설치됩니다.
가상 환경에 애플리케이션을 설치하기 전에 다음을 실행하여 활성화해야 합니다.
```
source myprojectenv/bin/activate
```
이제 가상 환경 내에서 작업 중임을 나타내도록 프롬프트가 변경됩니다. 다음과 같이 표시됩니다.
```
(myprojectenv)\ssammy@host:~/myproject$
```
3단계 — Flask 애플리케이션 설정
이제 가상 환경에 있으므로 Flask 및 Gunicorn을 설치하고 애플리케이션 설계를 시작할 수 있습니다.
먼저 pip의 로컬 인스턴스와 함께 wheel을 설치하여 휠 아카이브가 없는 경우에도 패키지가 설치되도록 합니다.
```
pip install wheel
```
참고: 사용 중인 Python 버전에 관계없이 가상 환경이 활성화되면 pip 명령(pip3 아님)을 사용해야 합니다.
다음으로 Flask와 Gunicorn을 설치합니다.
```
pip install gunicorn flask
```
이제 Flask를 사용할 수 있으므로 다음 단계에서 기본 애플리케이션을 만들 수 있습니다.
샘플 애플리케이션 생성
Flask는 마이크로프레임워크이기 때문에 더 많은 기능을 갖춘 프레임워크가 가질 수 있는 많은 도구를 포함하지 않습니다. Flask는 주로 웹 애플리케이션 초기화를 지원하기 위해 프로젝트로 가져올 수 있는 모듈로 존재합니다.
애플리케이션이 더 복잡할 수 있지만 Flask 애플리케이션을 myproject.py라는 단일 파일로 만들 것입니다. 원하는 텍스트 편집기를 사용하여 이 파일을 만듭니다. 여기서는 nano를 사용합니다.
```
nano ~/myproject/myproject.py
```
애플리케이션 코드는 이 파일에 있습니다. Flask를 가져오고 Flask 개체를 인스턴스화합니다. 이를 사용하여 특정 경로가 요청될 때 실행되어야 하는 기능을 정의할 수 있습니다.
```
from flask import Flask
app = Flask(__name__)

@app.route("/")
def hello():
    return "<h1 style='color:blue'>Hello There!</h1>"

if __name__ == "__main__":
    app.run(host='0.0.0.0')
```
이는 루트 도메인에 액세스할 때 표시할 콘텐츠를 정의합니다. 완료되면 파일을 저장하고 닫습니다. nano를 사용하는 경우 CTRL + X를 누른 다음 Y 및 ENTER를 눌러 이 작업을 수행할 수 있습니다.

전제 조건의 초기 서버 설정 가이드를 따랐다면 UFW 방화벽을 활성화해야 합니다. 애플리케이션을 테스트하려면 먼저 포트 5000에 대한 액세스를 허용해야 합니다.
```
sudo ufw allow 5000
```
그런 다음 다음을 실행하여 Flask 애플리케이션을 테스트할 수 있습니다.
```
python myproject.py
```
프로덕션 환경에서 이 서버 설정을 사용하지 않도록 알려주는 유용한 경고를 포함하여 다음과 같은 출력을 받게 됩니다.
```
Output * Serving Flask app 'myproject' (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: off
 * Running on all addresses.
   WARNING: This is a development server. Do not use it in a production deployment.
 * Running on http://your_server_ip:5000/ (Press CTRL+C to quit)
```
웹 브라우저에서 서버의 IP 주소 다음에 :5000을 방문하십시오.
```
http://your_server_ip:5000
```
다음과 같은 내용을 수신해야 합니다.
완료되면 터미널 창에서 CTRL + C를 눌러 Flask 개발 서버를 중지합니다.
WSGI 진입점 생성
다음으로 애플리케이션의 진입점 역할을 할 파일을 만듭니다. 이렇게 하면 Gunicorn 서버가 애플리케이션과 상호 작용하는 방법을 알 수 있습니다.
원하는 텍스트 편집기를 사용하여 새 파일을 만들고 이름을 지정합니다. 여기서 wsgi.py 파일을 호출합니다.
```
nano ~/myproject/wsgi.py
```
이 파일에서 애플리케이션의 Flask 인스턴스를 가져온 다음 실행합니다.
```
from myproject import app

if __name__ == "__main__":
    app.run()
```
완료되면 파일을 저장하고 닫습니다.
4단계 - Gunicorn 구성
이제 애플리케이션이 설정된 진입점으로 작성되었으며 Gunicorn 구성을 진행할 수 있습니다.
그러나 먼저 적절한 디렉토리로 변경하십시오.
```
cd ~/myproject
```
다음으로, Gunicorn에 진입점의 이름을 전달하여 애플리케이션을 올바르게 제공할 수 있는지 확인할 수 있습니다. 이것은 모듈의 이름(.py 확장자 제외)과 애플리케이션 내에서 호출 가능한 이름으로 구성됩니다. 우리의 경우 wsgi:app로 작성됩니다.
또한 애플리케이션이 공개적으로 사용 가능한 인터페이스에서 시작되도록 바인드할 인터페이스와 포트를 지정합니다.
```
gunicorn --bind 0.0.0.0:5000 wsgi:app
```
다음과 같은 출력이 표시됩니다.
```
Output[2021-11-19 23:07:57 +0000] [8760] [INFO] Starting gunicorn 20.1.0
[2021-11-19 23:07:57 +0000] [8760] [INFO] Listening at: http://0.0.0.0:5000 (8760)
[2021-11-19 23:07:57 +0000] [8760] [INFO] Using worker: sync
[2021-11-19 23:07:57 +0000] [8763] [INFO] Booting worker with pid: 8763
[2021-11-19 23:08:11 +0000] [8760] [INFO] Handling signal: int
[2021-11-19 23:08:11 +0000] [8760] [INFO] Shutting down: Master
```
웹 브라우저에서 다시 :5000이 추가된 서버의 IP 주소를 방문하십시오.
```
http://your_server_ip:5000
```
애플리케이션의 출력은 다음을 생성합니다.
제대로 작동하는지 확인했으면 터미널 창에서 CTRL + C를 누릅니다.
이제 가상 환경이 완료되었으므로 비활성화하십시오.
```
deactivate
```
모든 Python 명령은 이제 시스템의 Python 환경을 다시 사용합니다.
다음으로 systemd 서비스 단위 파일을 만듭니다. systemd 단위 파일을 생성하면 Ubuntu의 init 시스템이 자동으로 Gunicorn을 시작하고 서버가 부팅될 때마다 Flask 애플리케이션을 제공할 수 있습니다.
시작할 /etc/systemd/system 디렉토리 내에 .service로 끝나는 단위 파일을 생성합니다.
```
sudo nano /etc/systemd/system/myproject.service
```
내부에서 메타데이터 및 종속성을 지정하는 데 사용되는 [Unit] 섹션으로 시작합니다. 여기에 서비스 설명을 추가하고 네트워킹 대상에 도달한 후에만 서비스를 시작하도록 init 시스템에 지시합니다.
```
[Unit]
Description=Gunicorn instance to serve myproject
After=network.target
```
다음으로 [Service] 섹션을 만듭니다. 프로세스를 실행할 사용자 및 그룹을 지정합니다. 모든 관련 파일을 소유하고 있으므로 프로세스의 일반 사용자 계정 소유권을 제공하십시오. 또한 Nginx가 Gunicorn 프로세스와 통신할 수 있도록 www-data 그룹에 그룹 소유권을 부여합니다. 여기서 사용자 이름을 자신의 사용자 이름으로 바꿔야 합니다.
```
[Unit]
Description=Gunicorn instance to serve myproject
After=network.target

[Service]
User=sammy
Group=www-data
```
다음으로 작업 디렉토리를 매핑하고 PATH 환경 변수를 설정하여 init 시스템이 프로세스의 실행 파일이 가상 환경 내에 있음을 알 수 있도록 합니다. 또한 서비스를 시작하는 명령을 지정하십시오. 이 명령은 다음을 수행합니다.
- 3개의 작업자 프로세스 시작(필요에 따라 조정해야 함)
- 프로젝트 디렉토리 내에 Unix 소켓 파일 myproject.sock을 생성하고 바인딩합니다.
- 007의 umask 값을 설정하여 소켓 파일이 생성되어 소유자와 그룹에 액세스 권한을 부여하고 다른 액세스는 제한하도록 합니다.
- 해당 파일 내에서 호출 가능한 Python과 함께 WSGI 진입점 파일 이름을 지정합니다(wsgi:app).
Systemd에서는 가상 환경에 설치된 Gunicorn 실행 파일의 전체 경로를 제공해야 합니다.
사용자 이름과 프로젝트 경로를 자신의 정보로 바꾸는 것을 잊지 마십시오.
```
[Unit]
Description=Gunicorn instance to serve myproject
After=network.target

[Service]
User=sammy
Group=www-data
WorkingDirectory=/home/sammy/myproject
Environment="PATH=/home/sammy/myproject/myprojectenv/bin"
ExecStart=/home/sammy/myproject/myprojectenv/bin/gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi:app
```
마지막으로 [Install] 섹션을 추가합니다. 이것은 부팅 시 시작하도록 활성화한 경우 이 서비스를 연결할 항목을 systemd에 알려줍니다. 일반 다중 사용자 시스템이 실행 중일 때 이 서비스를 시작하려고 합니다.
```
[Unit]
Description=Gunicorn instance to serve myproject
After=network.target

[Service]
User=sammy
Group=www-data
WorkingDirectory=/home/sammy/myproject
Environment="PATH=/home/sammy/myproject/myprojectenv/bin"
ExecStart=/home/sammy/myproject/myprojectenv/bin/gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi:app

[Install]
WantedBy=multi-user.target
```
이것으로 systemd 서비스 파일이 완성되었습니다. 지금 저장하고 닫습니다.
이제 생성한 Gunicorn 서비스를 시작합니다.
```
sudo systemctl start myproject
```
그런 다음 부팅 시 시작되도록 활성화합니다.
```
sudo systemctl enable myproject
```
상태 확인:
```
sudo systemctl status myproject
```
다음과 같은 출력을 받아야 합니다.
```
Output● myproject.service - Gunicorn instance to serve myproject
   Loaded: loaded (/etc/systemd/system/myproject.service; enabled; vendor preset
   Active: active (running) since Fri 2021-11-19 23:08:44 UTC; 6s ago
 Main PID: 8770 (gunicorn)
    Tasks: 4 (limit: 1151)
   CGroup: /system.slice/myproject.service
       	├─9291 /home/sammy/myproject/myprojectenv/bin/python3.6 /home/sammy/myproject/myprojectenv/bin/gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi:app
       	├─9309 /home/sammy/myproject/myprojectenv/bin/python3.6 /home/sammy/myproject/myprojectenv/bin/gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi:app
       	├─9310 /home/sammy/myproject/myprojectenv/bin/python3.6 /home/sammy/myproject/myprojectenv/bin/gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi:app
       	└─9311 /home/sammy/myproject/myprojectenv/bin/python3.6 /home/sammy/myproject/myprojectenv/bin/gunicorn --workers 3 --bind unix:myproject.sock -m 007 wsgi:app
…
```
오류가 발생하면 자습서를 계속하기 전에 오류를 해결해야 합니다.
5단계 - 요청을 프록시하도록 Nginx 구성
이제 Gunicorn 애플리케이션 서버가 가동되어 프로젝트 디렉토리의 소켓 파일에 대한 요청을 기다리고 있어야 합니다. 다음으로 구성 파일에 약간의 추가 사항을 추가하여 Nginx가 해당 소켓에 웹 요청을 전달하도록 구성합니다.
Nginx의 sites-available 디렉터리에 새 서버 블록 구성 파일을 생성하여 시작합니다. 가이드의 나머지 부분과 일관성을 유지하기 위해 이 myproject를 호출합니다.
```
sudo nano /etc/nginx/sites-available/myproject
```
서버 블록을 열고 Nginx에게 기본 포트 80에서 수신하도록 지시합니다. 또한 서버의 도메인 이름 요청에 이 블록을 사용하도록 지시하십시오.
```
server {
    listen 80;
    server_name your_domain www.your_domain;
}
```
다음으로 모든 요청과 일치하는 위치 블록을 추가합니다. 이 블록 내에 설정해야 하는 일부 일반 프록시 매개변수를 지정하는 proxy_params 파일을 포함합니다. 그런 다음 proxy_pass 지시문을 사용하여 정의한 소켓에 요청을 전달합니다.
```
server {
    listen 80;
    server_name your_domain www.your_domain;

    location / {
        include proxy_params;
        proxy_pass http://unix:/home/sammy/myproject/myproject.sock;
    }
}
```
완료되면 파일을 저장하고 닫습니다.
생성한 Nginx 서버 블록 구성을 활성화하려면 파일을 sites-enabled 디렉터리에 연결합니다. 이 아닌 기호 또는 소프트 링크를 생성하기 위해 ln 명령과 -s 플래그를 실행하여 이 작업을 수행할 수 있습니다. 하드 링크:
```
sudo ln -s /etc/nginx/sites-available/myproject /etc/nginx/sites-enabled
```
해당 디렉토리의 링크를 사용하여 구문 오류를 테스트할 수 있습니다.
```
sudo nginx -t
```
문제를 나타내지 않고 반환되면 Nginx 프로세스를 다시 시작하여 새 구성을 읽습니다.
```
sudo systemctl restart nginx
```
마지막으로 방화벽을 다시 조정하십시오. 더 이상 포트 5000을 통한 액세스가 필요하지 않으므로 해당 규칙을 제거합니다.
```
sudo ufw delete allow 5000
```
그런 다음 Nginx 서버에 대한 전체 액세스를 허용합니다.
```
sudo ufw allow 'Nginx Full'
```
이제 웹 브라우저에서 서버의 도메인 이름으로 이동할 수 있습니다.
```
http://your_domain
```
애플리케이션의 출력이 브라우저에 표시됩니다.
오류가 발생하면 다음을 확인하십시오.
- sudo less /var/log/nginx/error.log: Nginx 오류 로그를 확인합니다.
- sudo less /var/log/nginx/access.log: Nginx 액세스 로그를 확인합니다.
- sudo journalctl -u nginx: Nginx 프로세스 로그를 확인합니다.
- sudo journalctl -u myproject: Flask 앱의 Gunicorn 로그를 확인합니다.
6단계 - 애플리케이션 보안
서버에 대한 트래픽을 안전하게 유지하려면 도메인에 대한 SSL 인증서를 받아야 합니다. Ubuntu 18.04에서 Nginx용 자체 서명 SSL 인증서를 만드는 방법에서 무료 인증서를 받는 등 여러 가지 방법이 있습니다. 편의상 옵션 1을 선택하겠습니다.
먼저 snap을 사용하여 Certbot을 설치합니다.
```
sudo snap install --classic certbot
```
출력에 Certbot의 현재 버전이 표시되고 성공적인 설치가 표시됩니다.
```
Outputcertbot 1.21.0 from Certbot Project (certbot-eff✓) installed
```
다음으로 /usr/bin/ 디렉터리에서 새로 설치된 /snap/bin/certbot 실행 파일에 대한 심볼릭 링크를 만듭니다. 이렇게 하면 certbot 명령이 서버에서 올바르게 실행될 수 있습니다.
```
sudo ln -s /snap/bin/certbot /usr/bin/certbot
```
Certbot은 플러그인을 통해 SSL 인증서를 얻는 다양한 방법을 제공합니다. Nginx 플러그인은 필요할 때마다 Nginx를 재구성하고 구성을 다시 로드합니다. 이 플러그인을 사용하려면 다음을 입력하십시오.
```
sudo certbot --nginx -d your_domain -d www.your_domain
```
이것은 --nginx 플러그인과 함께 certbot을 실행하고 -d를 사용하여 인증서를 유효하게 할 이름을 지정합니다.
certbot을 처음 실행하는 경우 이메일 주소를 입력하고 서비스 약관에 동의하라는 메시지가 표시됩니다. 이렇게 하면 certbot이 Let’s Encrypt 서버와 통신하여 도메인에 대한 인증서를 요청합니다. 성공하면 다음 출력이 표시됩니다.
```
OutputSuccessfully received certificate.
Certificate is saved at: /etc/letsencrypt/live/jeanellehorcasitasphd.com/fullchain.pem
Key is saved at:         /etc/letsencrypt/live/jeanellehorcasitasphd.com/privkey.pem
This certificate expires on 2022-03-03.
These files will be updated when the certificate renews.
Certbot has set up a scheduled task to automatically renew this certificate in the background.

Deploying certificate
Successfully deployed certificate foryour_domain to /etc/nginx/sites-enabled/myproject
Successfully deployed certificate for your_domain to /etc/nginx/sites-enabled/myproject
Congratulations! You have successfully enabled HTTPS on https://your_domain and https://your_domain

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
If you like Certbot, please consider supporting our work by:
 * Donating to ISRG / Let's Encrypt:   https://letsencrypt.org/donate
 * Donating to EFF:                    https://eff.org/donate-le
```
필수 구성 요소의 Nginx 설치 지침을 따랐다면 더 이상 중복 HTTP 프로필 허용이 필요하지 않습니다.
```
sudo ufw delete allow 'Nginx HTTP'
```
구성을 확인하려면 https://를 사용하여 도메인으로 다시 한 번 이동합니다.
```
https://your_domain
```
사이트가 안전하다는 것을 나타내는 브라우저의 보안 표시기와 함께 애플리케이션 출력을 다시 한 번 받아야 합니다.
결론
이 가이드에서는 Python 가상 환경 내에서 기본 Flask 애플리케이션을 만들고 보호했습니다. WSGI 지원 애플리케이션 서버가 인터페이스할 수 있도록 WSGI 진입점을 만든 다음 이 기능을 제공하도록 Gunicorn 애플리케이션 서버를 구성했습니다. 그런 다음 시스템 서비스 파일을 생성하여 부팅 시 애플리케이션 서버를 자동으로 시작했습니다. 또한 Let’s Encrypt를 사용하여 외부 요청 및 보안 트래픽을 서버로 릴레이하기 위해 웹 클라이언트 트래픽을 애플리케이션 서버로 전달하는 Nginx 서버 블록을 생성했습니다.
Flask는 구조와 디자인에 대해 너무 제한하지 않고 애플리케이션에 기능을 제공하기 위한 매우 유연한 프레임워크입니다. 이 가이드에 설명된 일반 스택을 사용하여 설계한 플라스크 애플리케이션을 제공할 수 있습니다.

Ubuntu 18.04에서 Gunicorn 및 Nginx로 Flask 애플리케이션을 제공하는 방법

소개

전제 조건

1단계 — Ubuntu 리포지토리에서 구성 요소 설치

2단계 — Python 가상 환경 만들기

3단계 — Flask 애플리케이션 설정

샘플 애플리케이션 생성

WSGI 진입점 생성

4단계 - Gunicorn 구성

5단계 - 요청을 프록시하도록 Nginx 구성

6단계 - 애플리케이션 보안

결론