fastapi-windows-service

KO | EN

gitlite — search

#javascript #ai #llm #android #docker #java #nodejs #windows #awesome #cli #kubernetes #awesome-list #vue #ios

fastapi-windows-service

(★ 15)

No description available.

fastapi-windows-service Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

This repository is for creating a FastAPI/Uvicorn windows service.

Note: You need Miniconda3 or Anaconda3 installed on your system.

---
## Steps for installing the service
1. Clone this repo
2. From the root repo directory run create_windows_service_installer.bat
3. Move the dist/windows_service folder to install location. Note: Don't move the folder after this otherwise the service won't work.
4. Open elevated command prompt (i.e. as Admin)
5. cd to repo root directory
6. Type install_windows_service.bat and press enter

The service will be installed on your system in auto run mode.

![Service list](https://raw.githubusercontent.com/msminhas93/fastapi-windows-service/main/docs/service-list.png)

You can start, stop, restart the service manually from the Services window.

Your service will be visible in the Task Manager details tab.

![Windows Service Process](https://raw.githubusercontent.com/msminhas93/fastapi-windows-service/main/docs/windows-service-process.png)

![Server processes](https://raw.githubusercontent.com/msminhas93/fastapi-windows-service/main/docs/server.png)

The Uvicorn server would be available at localhost:5000.

You can check the API swagger at localhost:5000/docs.

![FastAPI Swagger](https://raw.githubusercontent.com/msminhas93/fastapi-windows-service/main/docs/fastapi-swagger.png)

The available CLI options for the windows service executable are shown below.

![Windows Service CLI Options](https://raw.githubusercontent.com/msminhas93/fastapi-windows-service/main/docs/cli-options.png)

## Debugging

If for some reason you want to debug the server follow these steps:
1. Stop the FastAPI windows service
2. Run dist/windows_service/server/server.exe

You will be able to see logging values in the command prompt.

fastapi-windows-service

fastapi-windows-service Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

fastapi-windows-service

fastapi-windows-service Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README