.env.example

@@ -2,7 +2,7 @@
 ENABLE_REDIS=true
 
 # if cache enabled, sets redis url for Docker network (see docker-compose.yaml)
-REDIS_URL='redis://redis:6379'
+# REDIS_URL='redis://redis:6379'
 
 # if cache enabled, set redis url for external redis
-# REDIS_URL='redis://127.0.0.1:6379'
+REDIS_URL='redis://127.0.0.1:6379'

README.md

@@ -18,27 +18,55 @@ Self-hosted demo can be found [here](https://proxyraye.copyriot.xyz).
 
 You can run the project on local by cloning the repo. 
 
-Project requires no configuration. 
+## Docker
 
 You can run it via Docker with docker-compose by opening root folder via console and running:
 
 ```
+
 docker-compose up -d
+
 ```
+
 And head browser to `localhost:8069`.
 
-Or you can run it outside Docker via npm (tested with NodeJS `20.11`) by opening root folder via console and running:
+### Caching
+
+Starting from version `0.3.0` caching is enabled by default inside `docker-compose.yaml`. 
+
+A base Redis image will be added to the network.
+
+However, Proxy Raye can still work without Redis by setting `ENABLE_REDIS=false`  under `environment:`. 
+
+## Node.js
+
+You can also run project outside Docker via npm (tested with NodeJS `20.11` and above).
+
+You can run the project by opening root folder via console and running:
+
 ```
+
 npm install
+
 npm run build
+
 npm run start
+
 ```
+
 And head browser to `localhost:3000`.
 
-### WARNING:
-Proxy Raye tries to avoid ip blacklisting by setting random human-request-like headers at every call. But in the long run (after several hours of continuous requests) XVideos might **temporarily blacklist** your IP address. When this happen, it will stop returning HD videos from pages. Only low quality (SD) videos will be shown.
 
-Using a VPN can avoid such issue. 
+### (optional) Enable caching
+
+If you want to enable caching, please rename `.env.example` to `.env` file inside root folder. Inside `.env` file you will find following variables:
+
+```
+ENABLE_REDIS=true
+REDIS_URL='redis://127.0.0.1:6379'
+```
+These values assume a basic Redis instance running on local machine. If your local setup is different, or your Redis instance is somewhere else, please change `REDIS_URL` accordingly.
+
 
 # Modify
 If you want to edit the project you can start development mode by opening root folder via console and running: