Kumi
ef2ab5e519
Introduces MIT License for the project to clarify usage rights. Adds README with setup instructions and project details. Enhances app.py to allow configurable port via environment variable.
42 lines
1.4 KiB
Markdown
42 lines
1.4 KiB
Markdown
# noCDNbs - a privacy-friendly cdnjs proxy
|
|
|
|
noCDNbs is a Flask app that acts as a proxy for cdnjs. It allows you to use the CDN without disclosing your website visitors' IP addresses to Cloudflare.
|
|
|
|
## How it works
|
|
|
|
noCDNbs works by fetching the assets from Cloudflare and serving them to the client. This way, the client's IP address is never disclosed to Cloudflare. It does not store any data about the client.
|
|
|
|
Note that it does *not* modify the assets in any way. This means that the loaded assets may still contain tracking code or create connections to third-party servers, including cdnjs. You should always review the assets you load from a CDN.
|
|
|
|
## Setup
|
|
|
|
1. Clone the repository
|
|
|
|
```bash
|
|
git clone https://git.private.coffee/PrivateCoffee/nocdnbs.git
|
|
cd nocdnbs
|
|
```
|
|
|
|
2. Create a virtual environment and install the dependencies
|
|
|
|
```bash
|
|
python3 -m venv venv
|
|
source venv/bin/activate
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
3. Use the flask command or a WSGI server to run the app
|
|
|
|
```bash
|
|
flask run
|
|
```
|
|
|
|
In production, you should use a WSGI server like uWSGI, and a reverse proxy like Caddy. Ensure that your server does not log the client's IP address!
|
|
|
|
## Configuration
|
|
|
|
noCDNbs does not require any configuration. However, if you use `flask run`, you can set the `PORT` environment variable to change the port the app listens on. By default, it listens on port 5679.
|
|
|
|
## License
|
|
|
|
noCDNbs is licensed under the MIT License. See [LICENSE](LICENSE) for more information.
|