Deployment instruction for App Service

Author: rayluo

.env.sample

@@ -1,3 +1,6 @@
+# This one is required if you are deploying to Azure App Service.
+POST_BUILD_COMMAND=python manage.py migrate
+
 # The following variables are required for the app to run.
 CLIENT_ID=<client id>
 CLIENT_SECRET=<client secret>

README.md

@@ -38,6 +38,20 @@ to sign in users and make authenticated calls to the Microsoft Graph API.
    You may need to change to a different port to match your redirect_uri setup.
 2. Now visit http://localhost:5000
 
+### Deployment
+
+Once you finish testing this web app locally, you can deploy it to your production.
+You may choose any web app hosting services you want.
+Here we will describe how to deploy it to
+[Azure App Service](https://azure.microsoft.com/en-us/products/app-service).
+
+* Follow the ["Quickstart: Deploy a Python (Django or Flask) web app to Azure App Service"](https://learn.microsoft.com/en-us/azure/app-service/quickstart-python),
+  but replace its sample app (which does not do user sign-in) with this web app.
+
+* [Configure your app's settings](https://learn.microsoft.com/en-us/azure/app-service/configure-common?tabs=portal#configure-app-settings)
+  to define
+  [these environment variables](https://github.com/Azure-Samples/ms-identity-python-webapp-django/blob/main/.env.sample).
+
 
 ## Tutorial
 

mysite/settings.py

@@ -36,7 +36,16 @@
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
-ALLOWED_HOSTS = []
+
+if os.getenv("WEBSITE_HOSTNAME"):  # Settings for Azure App Service,
+    # See https://learn.microsoft.com/en-us/azure/app-service/configure-language-python#production-settings-for-django-apps
+    ALLOWED_HOSTS = [os.getenv("WEBSITE_HOSTNAME")]
+
+    # See https://learn.microsoft.com/en-us/azure/app-service/configure-language-python#detect-https-session
+    SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
+    USE_X_FORWARDED_HOST = True
+else:
+    ALLOWED_HOSTS = []
 
 
 # Application definition

templates/index.html

@@ -8,8 +8,11 @@
     <h1>Microsoft Entra ID Django Web App Sample {{version}}</h1>
     <h2>Welcome {{ user.name }}!</h2>
 
-    {% load static %}
-    <img src="{% static 'topology.png' %}" alt="Topology">
+    <!-- There is much hussle to get the local static image to show up on App Service.
+    https://learn.microsoft.com/en-us/azure/app-service/configure-language-python#serve-static-files-for-django-apps
+    For now, we will use a remote image.
+    -->
+    <img src="https://github.com/Azure-Samples/ms-identity-python-webapp-django/raw/main/static/topology.png" alt="Topology">
 
     <ul>
     {% if downstream_api %}