42 lines
1.2 KiB
Markdown
42 lines
1.2 KiB
Markdown
<h1 align="center">
|
|
<a href="https://github.com/TxtDot/txtdot"><img src="https://github.com/TxtDot/.github/blob/main/imgs/TXTDot%20gh.png?raw=true" alt="txt." width="200"></a>
|
|
<br>
|
|
<a href="https://github.com/TxtDot/txtdot/blob/main/LICENSE"><img alt="MIT license" src="https://img.shields.io/github/license/txtdot/txtdot?color=blue"></a>
|
|
<a href="https://github.com/TxtDot/txtdot/releases/latest"><img alt="Latest release" src="https://img.shields.io/github/v/release/TxtDot/txtdot?display_name=release"></a>
|
|
<a href="https://matrix.to/#/#txtdot:matrix.org"><img alt="Matrix chat" src="https://img.shields.io/badge/chat-matrix-blue"></a>
|
|
</h1>
|
|
|
|
HTTP proxy that parses only text, links and pictures from pages
|
|
reducing internet traffic, removing ads and heavy scripts.
|
|
|
|
Uses [Mozilla's readability.js](https://github.com/mozilla/readability),
|
|
[JSDOM](https://github.com/jsdom/jsdom),
|
|
[Fastify web framework](https://github.com/fastify/fastify).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
## Running
|
|
|
|
### Dev
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
### Prod
|
|
|
|
```bash
|
|
npm run build
|
|
npm run start
|
|
```
|
|
|
|
### Docker
|
|
```bash
|
|
sudo docker build -t txtdot/txtdot:1.2.0 .
|
|
sudo docker run --network host -d txtdot/txtdot:1.2.0
|
|
```
|