> [!WARNING] > The project is frozen for a while. txtdot needs a complete rewrite in rust and dalet integration, which is not finished yet.

![txtdot logo](https://github.com/TxtDot/.github/raw/main/imgs/txtdot.png)

# txtdot

HTTP proxy that parses only text, links and pictures from pages reducing internet traffic, removing ads and heavy scripts. Mozilla's Readability library is used under the hood. ## Features - Server-side page simplification - Media proxy - Image compression with Sharp - Rendering client-side apps (Vanilla, React, Vue, etc) with [webder](https://github.com/TxtDot/webder) - Search with SearXNG - Handy API endpoints - No client JavaScript - Some kind of Material Design 3 - Customization with plugins, see [@txtdot/sdk](https://github.com/TxtDot/txtdot/tree/main/packages/sdk) and [@txtdot/plugins](https://github.com/TxtDot/txtdot/tree/main/packages/plugins) ## Running ### Development ```bash npm install npm run dev ``` ### Production ```bash npm install npm run build npm run start ``` ### Docker ```bash docker compose up -d ``` ## Screenshots

## Performance tests txtdot is a great tool in case of slow internet connection or weak signal. Here is the comparision of performance metrics from pagespeed.web.dev between original page and proxied one. "Mobile" test includes "Slow 4G" artificial network throttling.

Expand

| | Original page | Proxied through txtdot | | :------------------------------- | :-------------------: | :--------------------: | | [Habr][habr-link] Desktop | ![56%][habr-do-img] | ![99%][habr-dt-img] | | [Habr][habr-link] Mobile | ![21%][habr-mo-img] | ![100%][habr-mt-img] | | [Medium][medium-link] Desktop | ![44%][medium-do-img] | ![100%][medium-dt-img] | | [Medium][medium-link] Mobile | ![36%][medium-mo-img] | ![100%][medium-mt-img] | | [Nginx Blog][nginx-link] Desktop | ![53%][nginx-do-img] | ![100%][nginx-dt-img] | | [Nginx Blog][nginx-link] Mobile | ![26%][nginx-mo-img] | ![100%][nginx-mt-img] | [habr-link]: https://habr.com/ru/articles/780692/ [habr-do-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/habr/desktop_orig.png [habr-dt-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/habr/desktop_txtdot.png [habr-mo-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/habr/mobile_orig.png [habr-mt-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/habr/mobile_txtdot.png [medium-link]: https://levelup.gitconnected.com/proxy-servers-how-proxies-work-0ec083fc1030 [medium-do-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/medium/desktop_orig.png [medium-dt-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/medium/desktop_txtdot.png [medium-mo-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/medium/mobile_orig.png [medium-mt-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/medium/mobile_txtdot.png [nginx-link]: https://www.nginx.com/blog/rate-limiting-nginx/ [nginx-do-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/nginx-blog/desktop_orig.png [nginx-dt-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/nginx-blog/desktop_txtdot.png [nginx-mo-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/nginx-blog/mobile_orig.png [nginx-mt-img]: https://raw.githubusercontent.com/TxtDot/.github/main/tests/nginx-blog/mobile_txtdot.png

## Credits - [Readability.js](https://github.com/mozilla/readability) - [🔗 LinkeDOM](https://github.com/WebReflection/linkedom) - [Fastify web framework](https://github.com/fastify/fastify) - [EJS](https://github.com/mde/ejs) - [Axios](https://github.com/axios/axios) - [DOMPurify](https://github.com/cure53/DOMPurify) - [Sharp](https://github.com/lovell/sharp) - [MicroMatch](https://github.com/micromatch/micromatch) - [RouteParser](https://github.com/rcs/route-parser) - [IconvLite](https://github.com/ashtuchkin/iconv-lite)