lamacchinadesiderante/proxyraye-nextjs
lamacchinadesiderante
/
proxyraye-nextjs
0
0
Fork 0
Code Issues 20 Pull Requests Packages Projects 6 Releases 7 Wiki Activity

update README with encoding key details

This commit is contained in:
La macchina desiderante 2024-05-24 23:30:30 +02:00
parent 702b67bdd7
commit 69dd722514
1 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -6,7 +6,7 @@ Proxy Raye is an alternative front-end for adult websites. Watch videos on a cle
- XVideos - XVideos
- XNXX - XNXX
- (...more coming soon!) - PornHub (experimental)
## Working demos ## Working demos
@ -18,9 +18,19 @@ Self-hosted demo can be found [here](https://proxyraye.copyriot.xyz).
You can run the project on local by cloning the repo. You can run the project on local by cloning the repo.
## IMPORTANT: encoding key generation:
Since version `0.4.0` server-side video streaming is supported and mandatory for some platforms (like PornHub) in order to work properly. In order to avoid random video url injection, urls get encrypted/decrypted by using an encoding key.
For security reasons it's better to generate a new encoding key. It can be done via console/terminal by running `pwgen 20 1` command. Make sure `pwgen` command is installed. This will generate an alphanumeric string.
Paste the string to `ENCODING_KEY` environment variable inside `docker-compose.yaml` if you are using Docker, or inside `.env` file if you run the project with npm. See detailed instructions below.
In case variable is not set, a default encoding key will be used (not recommended!).
## Docker ## Docker
You can run it via Docker with docker-compose by opening root folder via console and running: You can run project via Docker with docker-compose by opening root folder via console and running:
``` ```
docker-compose up -d docker-compose up -d
@ -36,6 +46,10 @@ 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:`. However, Proxy Raye can still work without Redis by setting `ENABLE_REDIS=false` under `environment:`.
### Encoding urls
Please uncomment `ENCODING_KEY=` related line inside `docker-compose.yaml` (under `environment:`) and set value to the string obtained by running `pwgen 20 1`.
## Node.js ## Node.js
You can also run project outside Docker via npm (tested with NodeJS `20.11` and above). You can also run project outside Docker via npm (tested with NodeJS `20.11` and above).
@ -50,6 +64,11 @@ npm run start
And head browser to `localhost:3000`. And head browser to `localhost:3000`.
### Encoding urls
Please rename `.env.example` to `.env` file inside root folder.
Please uncomment `ENCODING_KEY=` related line inside `.env` file and set value to the string obtained by running `pwgen 20 1`.
### (optional) Enable caching ### (optional) Enable caching
@ -61,7 +80,6 @@ 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. 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 # Modify
If you want to edit the project you can start development mode by opening root folder via console and running: If you want to edit the project you can start development mode by opening root folder via console and running: