diff --git a/README.md b/README.md index 3663e91..7298eb8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,13 @@ # profile-api Generate easy Profile pictures and more! + +## Running locally + +Install dependencies from `requirements.txt` and start the server with: + +```bash +python main.py +``` + +The API listens on `0.0.0.0:5000`, making it reachable from other machines on the +network. diff --git a/main.py b/main.py index ef20d2a..03bdf08 100644 --- a/main.py +++ b/main.py @@ -26,4 +26,5 @@ def create_pic(): if __name__ == "__main__": - app.run() + # Bind to all interfaces so the API is reachable outside the container/host. + app.run(host="0.0.0.0")