typenot/README.md
Kumi ef163dfac2
feat: Enhances README with proxy usage details
Adds clarification on CSS modifications pointing font URLs
to the proxy, ensuring client privacy. Introduces a disclaimer
highlighting potential connections to Adobe's servers and
encourages hosting fonts locally for increased assurance.
2024-11-27 12:49:36 +01:00

46 lines
1.6 KiB
Markdown

# TypeNot - a privacy-friendly Typekit proxy
TypeNot is a Flask app that acts as a proxy for Typekit fonts. It allows you to use Typekit fonts without disclosing your website visitors' IP addresses to Adobe.
## How it works
TypeNot works by fetching the font files from Typekit and serving them to the client. This way, the client's IP address is never disclosed to Adobe. It does not store any data about the client.
It modifies the CSS files so that the font URLs also point to the proxy. This way, the client's browser fetches the font files from the proxy instead of Adobe.
### Disclaimer
We try our best to ensure that users do not make any connections to Adobe's servers. However, we cannot guarantee that we catch everything. If you find any issues, please report them. And if at all possible, please host your own fonts instead of using Typekit.
## Setup
1. Clone the repository
```bash
git clone https://git.private.coffee/PrivateCoffee/typenot.git
cd typenot
```
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
TypeNot 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 5690.
## License
TypeNot is licensed under the MIT License. See [LICENSE](LICENSE) for more information.