Getting Started with QuickServe
Follow these simple steps to set up your own QuickServe file server and start sharing files.
Get the latest release for your operating system
Download QuickServe
Get the latest release of QuickServe for your operating system from the GitHub releases page.
If you downloaded a compiled release (.exe for Windows or binary for Linux), you can skip the Python installation and dependency steps. Simply run the binary directly from your terminal (cmd/powershell or bash) instead of using python to launch the scripts.
For Source Code Users:
If you're using the source code version, ensure you have Python + Pip installed and install the required dependencies:
pip install -r backend/requirements.txt
Configure Your Server
Before running the server, configure it using the built-in configurator:
cd backend python qconfig.py
This launches an interactive menu where you can:
- Set server port (default: 5000)
- Configure CORS origins
- Add user accounts with passwords
- Manage server settings
CORS origins should be properly configured for use. Default configuration allows only official login portal.
Run the Server
Start your QuickServe file server:
python quickserve.py
The server will start and display access URLs for both local and network access.
Configure Frontend Access
Choose how to access your QuickServe web interface:
Option 1: Use Official Frontend
To use the official web interface at
https://quickserve.noman.qzz.io, you must allow it
as a CORS origin in your configuration:
- Run
python qconfig.py - Select "Manage CORS Origins"
-
Add
https://quickserve.noman.qzz.ioto allowed origins
Option 2: Self-Hosted Frontend
Alternatively, you can host the frontend files yourself:
-
Serve the
frontend/directory with any web server - Add your frontend URL to CORS origins in the configuration
- Access your self-hosted interface instead
Access Your Server
After starting the server, access it via:
Local: http://localhost:{port}
Network: http://{your-ip}:{port}
Use the web interface to login and manage files.