Update for Hugging Face Spaces deployment: Change port to 80 and update documentation

Dockerfile

@@ -72,16 +72,15 @@ RUN . /app/venv/bin/activate && pip install --no-cache-dir -r requirements.txt
 # Copy the rest of the application code into the container
 COPY . .
 
-# Make port 5001 available to the world outside this container
-# This should match the port Flask runs on in app.py (or Gunicorn config)
-EXPOSE 5001
+# Make port 80 available to the world outside this container (required for Hugging Face Spaces)
+EXPOSE 80
 
 # Define environment variables
 # IMPORTANT: Set a strong FLASK_SECRET_KEY when running the container!
 # Using a placeholder here for demonstration.
 ENV FLASK_APP=app.py
 ENV FLASK_RUN_HOST=0.0.0.0
-ENV FLASK_RUN_PORT=5001
+ENV FLASK_RUN_PORT=80
 ENV FLASK_SECRET_KEY="replace_this_in_docker_run_with_a_real_secret"
 # Add venv's bin to the PATH for subsequent commands (like CMD)
 ENV PATH="/app/venv/bin:$PATH"
@@ -92,7 +91,7 @@ ENTRYPOINT []
 # Run the application using Gunicorn when the container launches
 # Use the full path to gunicorn within the virtual environment
 # Bind to 0.0.0.0 to accept connections from outside the container
-# Use the port defined by FLASK_RUN_PORT
+# Use port 80 (required for Hugging Face Spaces)
 # The number of workers (e.g., --workers 3) can be adjusted based on server resources
 # Use JSON form with the absolute path to gunicorn in the venv to avoid PATH issues
-CMD ["/app/venv/bin/gunicorn", "--workers", "3", "--bind", "0.0.0.0:5001", "--timeout", "60", "app:app"]
+CMD ["/app/venv/bin/gunicorn", "--workers", "3", "--bind", "0.0.0.0:80", "--timeout", "60", "app:app"]

README.md

@@ -1,11 +1,12 @@
 ---
 title: Mermaid Rendering Docker
-emoji: 🚀
-colorFrom: indigo
-colorTo: yellow
+emoji: 🔥
+colorFrom: purple
+colorTo: red
 sdk: docker
 pinned: false
 license: mit
+short_description: mermaid-rendering docker version
 ---
 
 Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
@@ -68,15 +69,15 @@ This is the recommended way to run the application, as it bundles all dependenci
     ```bash
     # Replace 'YOUR_GENERATED_SECRET_KEY' with the key from step 2.
     # -d: Run in detached mode (background)
-    # -p 80:5001: Map port 80 on the host to port 5001 in the container
+    # -p 80:80: Map port 80 on the host to port 80 in the container
     # --name mermaid-app: Assign a name to the container for easier management
     # -e FLASK_SECRET_KEY=...: Set the environment variable inside the container
     # mermaid-renderer-app: The name of the image to run
-    docker run -d -p 80:5001 --name mermaid-app \
+    docker run -d -p 80:80 --name mermaid-app \
       -e FLASK_SECRET_KEY='YOUR_GENERATED_SECRET_KEY' \
       mermaid-renderer-app
     ```
-    *Note:* If port 80 is already in use on your host, choose a different host port (e.g., `-p 8080:5001`).
+    *Note:* If port 80 is already in use on your host, choose a different host port (e.g., `-p 8080:80`).
 
 5.  **Access the Application:** Open your web browser and navigate to `http://localhost` (or `http://your_server_ip` if deploying remotely). If you used a different host port, include it (e.g., `http://localhost:8080`).
 

app.py

@@ -184,5 +184,5 @@ if __name__ == '__main__':
     # Use 0.0.0.0 to be accessible on the network
     # Set debug=False for production-like testing, or True for development features
     is_debug = os.environ.get('FLASK_DEBUG', 'false').lower() == 'true'
-    # Changed default port from 5000 to 5001 to avoid conflicts
-    app.run(debug=is_debug, host='0.0.0.0', port=int(os.environ.get('PORT', 5001)))
+    # Use port 80 for Hugging Face Spaces compatibility
+    app.run(debug=is_debug, host='0.0.0.0', port=int(os.environ.get('PORT', 80)))