diff --git a/server/.gitignore b/server/.gitignore index 240b29e..01f7a99 100644 --- a/server/.gitignore +++ b/server/.gitignore @@ -2,7 +2,7 @@ .DS_STORE # Models -models/ +models/*.bin # Local Chroma db .chroma/ diff --git a/server/README.md b/server/README.md index b35030a..3fb3a58 100644 --- a/server/README.md +++ b/server/README.md @@ -1 +1,24 @@ -# privateGPT Server \ No newline at end of file +# privateGPT Server + +A Flask application to manage your privateGPT instance. + +## MacOS Installation Notes + +Ensure you run: + +```sh +pip install urllib3==1.26.6 +``` + +To fix the lingering OpenSSL issue. + +Now, you can execute: + +```sh +python privateGPT.py +``` + +The server should be running on Port 5000. + +If port 5000 is in use, on your Mac go to System Settings > Airdrop and Handoff +and disable the Airplay Receiver as it runs on port 5000. \ No newline at end of file diff --git a/server/models/.gitkeep b/server/models/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/server/requirements.txt b/server/requirements.txt index dd1b9c5..f4d96d2 100644 --- a/server/requirements.txt +++ b/server/requirements.txt @@ -94,7 +94,7 @@ python-magic==0.4.27 python-pptx==0.6.21 pytz==2023.3 pytz-deprecation-shim==0.1.0.post0 -pywin32==306 +pywin32==306; sys_platform == 'win32' PyYAML==6.0 red-black-tree-mod==1.20 regex==2023.5.5