README updated to match latest updates

Author: aledipa

README.md

@@ -1,160 +1,282 @@
-
 <img src="./img/FreeGPT4_Banner(Nicoladipa).png" style="width:100%; max-width:500px; min-width:200px; aspect-ratio: 5/2"/>
 
 [![Docker Image CI](https://github.com/aledipa/Free-GPT4-WEB-API/actions/workflows/docker-image.yml/badge.svg)](https://github.com/aledipa/Free-GPT4-WEB-API/actions/workflows/docker-image.yml)
 [![GPT4-API-PyApp](https://github.com/aledipa/Free-GPT4-WEB-API/actions/workflows/python-app.yml/badge.svg)](https://github.com/aledipa/Free-GPT4-WEB-API/actions/workflows/python-app.yml)
 ![Docker Pulls](https://img.shields.io/docker/pulls/d0ckmg/free-gpt4-web-api)
 
-<!-- <img src="https://status.freegpt4.ddns.net/getstatus" width="256" height="40" /> -->
-
 # Free-GPT4-WEB-API
 
-FreeGPT4-WEB-API is a python server that allows you to have a self-hosted GPT-4 Unlimited and Free WEB API, via the latest AI providers.
+Self-hosted web API that exposes free, unlimited access to modern LLM providers through a single, simple HTTP interface. It includes an optional web GUI for configuration and supports running via Python or Docker.
+
+- Free to use
+- Unlimited requests
+- Simple HTTP interface (returns plain text)
+- Optional Web GUI
+- Docker image available
+
+Note: The demo server, when available, can be overloaded and may not always respond.
+
+---
+
+## Table of contents
+
+- Features
+- Screenshots
+- Quick start
+  - Run with Docker
+  - Run from source
+- Usage
+  - Quick examples (browser, curl, Python)
+  - File input
+  - Web GUI
+- Command-line options
+- Configuration
+  - Cookies
+  - Proxies
+  - Models and providers
+  - Private mode and password
+- Siri integration
+- Requirements
+- Star history
+- Contributing
+- License
+
+---
 
 ## Features
+
 - Self-hosted DeepSeek-R1 and GPT-4o API
 - Unlimited usage
 - Free of cost
 - User-friendly GUI
 
+## Screenshots
 
-## GUI Preview:
-
-<!-- round angles images -->
 <img src="./img/login.png" style="width:100%; max-width:500px; min-width:200px; aspect-ratio: 4/3" />
 <img src="./img/settings.png" style="width:100%; max-width:500px; min-width:200px; aspect-ratio: 4/3" />
+<img src="./img/profile.png" style="width:100%; max-width:500px; min-width:200px; aspect-ratio: 4/3" />
 
-## Installation
-1. Clone the repository: `git clone https://github.com/aledipa/Free-GPT4-WEB-API.git`
-2. Navigate to the project directory: `cd Free-GPT4-WEB-API`
-3. Install the required packages: `pip install -r requirements.txt`
+---
 
-## Requirements
+## Quick start
 
-- Python 3
-- Flask[async]
-- g4f (from [here](https://github.com/xtekky/gpt4free)).
-- aiohttp
-- aiohttp_socks
-- auth
-- Werkzeug
+### Option A: Run with Docker
 
-## Usage
+Pull and run with an optional cookies.json and port mapping. In Docker, setting a GUI password is recommended (and required by some setups).
 
-_Note: It is recommended to [use the GUI](#to-use-the-web-gui)._
+- Minimal (no cookies):
+```
+docker run -p 5500:5500 d0ckmg/free-gpt4-web-api:latest
+```
 
-### Run the server 
-Use the following command:
-```shell
-python3 FreeGPT4_Server.py [-h] [--remove-sources] [--enable-gui] 
-                           [--private-mode] [--enable-history] [--password PASSWORD] 
-                           [--cookie-file COOKIE_FILE] [--file-input] [--port PORT] 
-                           [--model MODEL] [--provider PROVIDER] [--keyword KEYWORD] 
-                           [--system-prompt SYSTEM_PROMPT] [--enable-proxies]
+- With cookies (read-only mount):
+```
+docker run \
+  -v /path/to/your/cookies.json:/cookies.json:ro \
+  -p 5500:5500 \
+  d0ckmg/free-gpt4-web-api:latest
 ```
 
+- Override container port mapping:
+```
+docker run -p YOUR_PORT:5500 d0ckmg/free-gpt4-web-api:latest
+```
 
-Options:
+- docker-compose.yml:
+```yaml
+version: "3.9"
+services:
+  api:
+    image: "d0ckmg/free-gpt4-web-api:latest"
+    ports:
+      - "YOUR_PORT:5500"
+    #volumes:
+    #  - /path/to/your/cookies.json:/cookies.json:ro
+```
+
+Note:
+- If you plan to use the Web GUI in Docker, set a password (see “Command-line options”).
+- The API listens on port 5500 in the container.
+
+### Option B: Run from source
+
+1. Clone the repo
+```
+git clone https://github.com/aledipa/Free-GPT4-WEB-API.git
+cd Free-GPT4-WEB-API
+```
+
+2. Install dependencies
+```
+pip install -r requirements.txt
+```
 
-  `-h, --help`            show this help message and exit
-  
-  `--remove-sources`      Remove the sources from the response
-  
-  `--enable-gui`          Use a graphical interface for settings
-  
-  `--private-mode`        Use a private token to access the API
-  
-  `--enable-history`      Enable the history of the messages
-  
-  `--password PASSWORD`   Set or change the password for the settings page [mandatory in docker envirtonment]
-  
-  `--cookie-file COOKIE_FILE`
-                        Use a cookie file
-  
-  `--file-input`          Add the file as input support
-  
-  `--port PORT`           Change the port (default: 5500)
-  
-  `--model MODEL`         Change the model (default: gpt-4)
-  
-  `--provider PROVIDER`   Change the provider (default: Bing)
-  
-  `--keyword KEYWORD`     Add the keyword support
-  
-  `--system-prompt SYSTEM_PROMPT`
-                        Use a system prompt to 'customize' the answers
-  
-  `--enable-proxies`
-                         Use one or more proxies to avoid being blocked or banned
-
-### Make questions
-Once the server is up and running, make sure that you're able to reach its address and type `?text=` followed by your question next to it.
-You can replace ‘text’ with whatever you wish, either by using the `--keyword` flag or by changing the value of the ‘Input Keyword’ field on the Web GUI.
-
-### Use the Web GUI
-Once you've enabled it by running the server with the `--enable-gui` flag, just type `/settings` or `/login` next to the server's url
-
-### Use it with Curl 
-(credits to [@ayoubelmhamdi](https://github.com/ayoubelmhamdi)):
-
-```shell
+3. Start the server (basic)
+```
+python3 FreeGPT4_Server.py
+```
+
+---
+
+## Usage
+
+The API returns plain text by default.
+
+- Quick browser test:
+  - Start the server
+  - Open: http://127.0.0.1:5500/?text=Hello
+
+Examples:
+- GET http://127.0.0.1:5500/?text=Write%20a%20haiku
+- If you changed the keyword parameter (see `--keyword`), replace `text` with your chosen keyword.
+
+### curl examples
+
+- Simple text prompt:
+```
+curl "http://127.0.0.1:5500/?text=Explain%20quicksort%20in%20simple%20terms"
+```
+
+- File input (see `--file-input` in options):
+```
 fileTMP="$1"
 curl -s -F file=@"${fileTMP}" http://127.0.0.1:5500/
 ```
 
+### Python example
 
-## Docker Installation
-<img src="./img/docker-logo.webp" width="400" height="100" />
+```python
+import requests
 
-It's possible to install the docker image of this API by running this command:
+resp = requests.get("http://127.0.0.1:5500/", params={"text": "Give me a limerick"})
+print(resp.text)
+```
 
-`docker container run -v /path/to/your/cookies.json:/cookies.json:ro -p YOUR_PORT:5500 d0ckmg/free-gpt4-web-api`
+### Web GUI
 
-just omit <code>-v /path/to/your/cookies.json:/cookies.json:ro</code> for using it without cookies
+- Start with GUI enabled:
+```
+python3 FreeGPT4_Server.py --enable-gui
+```
 
-or alternatively, you can use a docker-compose file:
+- Open settings or login:
+  - http://127.0.0.1:5500/settings
+  - http://127.0.0.1:5500/login
 
-**docker-compose.yml**
+From the GUI you can configure common options (e.g., model, provider, keyword, history, cookies).
 
-```yaml
-version: "3.9"
-services:
-  api:
-    image: "d0ckmg/free-gpt4-web-api:latest"
-    ports:
-      - "YOUR_PORT:5500"
-    #volumes:
-    #  - /path/to/your/cookies.json:/cookies.json:ro
+---
+
+## Command-line options
+
+Show help:
+```
+python3 FreeGPT4_Server.py [-h] [--remove-sources] [--enable-gui]
+                           [--private-mode] [--enable-history] [--password PASSWORD]
+                           [--cookie-file COOKIE_FILE] [--file-input] [--port PORT]
+                           [--model MODEL] [--provider PROVIDER] [--keyword KEYWORD]
+                           [--system-prompt SYSTEM_PROMPT] [--enable-proxies] [--enable-virtual-users]
 ```
 
-This will start the server and allow you to access the GPT-4 WEB API.
+Options:
+- -h, --help                 Show help and exit
+- --remove-sources           Remove sources from responses
+- --enable-gui               Enable graphical settings interface
+- --private-mode             Require a private token to access the API
+- --enable-history           Enable message history
+- --password PASSWORD        Set/change the password for the settings page
+  - Note: Mandatory in some Docker environments
+- --cookie-file COOKIE_FILE  Use a cookie file (e.g., /cookies.json)
+- --file-input               Enable file-as-input support (see curl example)
+- --port PORT                HTTP port (default: 5500)
+- --model MODEL              Model to use (default: gpt-4)
+- --provider PROVIDER        Provider to use (default: Bing)
+- --keyword KEYWORD          Change input query keyword (default: text)
+- --system-prompt SYSTEM_PROMPT
+                             System prompt to steer answers
+- --enable-proxies           Use one or more proxies to reduce blocking
+- --enable-virtual-users
+                             Enable virtual users to divide requests among multiple users
+
+---
+
+## Configuration
+
+### Cookies
 
-Once the server is running, you can access the API by sending HTTP requests to the server's address. The data for the requests should be sent via hotlinking and the response will be returned as plain text.
+Some providers require cookies to work properly. For the Bing model, only the “_U” cookie is needed.
 
-For example, to generate text using the API, you can send a GET request with the `text` parameter set to the text you want to use as a prompt and the (optional) `style` parameter set to the style you want to use. The default style is "balanced" and is recommended since it is faster. The generated text will be returned in the response as plain text.
+- Passing cookies via file:
+  - Use `--cookie-file /cookies.json` when running from source
+  - In Docker, mount your cookies file read-only: `-v /path/to/cookies.json:/cookies.json:ro`
+- The GUI also exposes cookie-related settings.
 
-To stop the server, you can press `CTRL+C` in the terminal where the server is running.
-(credits to [@git-malik](https://github.com/git-malik))
+### Proxies
+
+Enable proxies to mitigate blocks:
+- Start with `--enable-proxies`
+- Ensure your environment is configured for aiohttp/aiohttp_socks if you need SOCKS/HTTP proxies.
+
+### Models and providers
+
+- Models: includes gpt-4 (and variants such as GPT-4o) and DeepSeek-R1
+- Default model: `gpt-4`
+- Default provider: `Bing`
+- Change via flags or in the GUI:
+```
+--model gpt-4o --provider Bing
+```
+
+### Private mode and password
+
+- `--private-mode` requires a private token to access the API
+- `--password` protects the settings page (mandatory in some Docker setups)
+- Use a strong password if you expose the API beyond localhost
+
+---
+
+## Siri integration
 
-## Siri Integration
 <img src="./img/GPTMode_Logo.png" width="400" height="133" />
 
-You can implement the power of GPT4 in Siri by using the [GPTMode Apple Shortcut](https://www.icloud.com/shortcuts/bfeed30555854958bd6165fa4d82e21b).
-Then you can use it just by saying "GPT Mode" to Siri and then ask your question when prompted to do so.
+Use the GPTMode Apple Shortcut to ask your self-hosted API via Siri.
 
-## Configuration
+Shortcut:
+- https://www.icloud.com/shortcuts/bfeed30555854958bd6165fa4d82e21b
+
+Say “GPT Mode” to Siri and ask your question when prompted.
 
-The server can be configured by using the GUI or the corresponding parameters. The only cookie needed for the Bing model is _"_U"_.
+---
 
-## Star History
+## Requirements
+
+- Python 3
+- Flask[async]
+- g4f (from https://github.com/xtekky/gpt4free)
+- aiohttp
+- aiohttp_socks
+- auth
+- Werkzeug
+
+---
+
+## Star history
 
 [![Star History Chart](https://api.star-history.com/svg?repos=aledipa/Free-GPT4-WEB-API&type=Date)](https://star-history.com/#aledipa/Free-GPT4-WEB-API&Date)
 
-## Notes
+---
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues and pull requests to improve features, docs, or reliability.
+
+Credits:
+- Some examples and tips credited to community members, including @git-malik and @ayoubelmhamdi.
+
+---
+
+## License
 
-- The demo server may be overloaded and not always work as expected. (Check the "Demo Server Status" above)
-- Any kind of contribution to the repository is welcome.
+GNU General Public License v3.0
 
-## Todo ✔️
-- [x] Fix Demo Server
-- [x] Update README
+See LICENSE for details.