2022-02-17 12:56:04 -08:00
|
|
|
<h1 align="center">LibreX</h1>
|
2022-02-20 14:06:07 -08:00
|
|
|
|
2022-02-17 12:56:04 -08:00
|
|
|
<p align="center">
|
2022-02-25 01:50:51 -08:00
|
|
|
<img src="https://user-images.githubusercontent.com/49120638/155693689-d217d78d-42a7-4b35-b5f3-8b6eca1b8553.png" width=500>
|
|
|
|
|
<img src="https://user-images.githubusercontent.com/49120638/155693795-7a35e40c-4f02-499c-9711-586d6c1f9f42.png" width=500>
|
2022-02-17 12:56:04 -08:00
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
|
2022-03-01 08:37:56 -08:00
|
|
|
<p align="center">A privacy respecting free as in freedom meta search engine</p>
|
2022-02-17 12:56:04 -08:00
|
|
|
|
|
|
|
|
# Online instances
|
2022-02-23 03:51:35 -08:00
|
|
|
+ [search.davidovski.xyz](https://search.davidovski.xyz/) 🇬🇧
|
2022-02-17 12:56:04 -08:00
|
|
|
|
2022-03-01 08:37:56 -08:00
|
|
|
If you wish to get your instance added create an issue with the `new instance` label and this information:
|
2022-02-19 05:08:42 -08:00
|
|
|
+ the URL of your instance
|
|
|
|
|
+ the country where your instance is being hosted
|
|
|
|
|
|
|
|
|
|
Your request will be **rejected** if your instance:
|
|
|
|
|
+ contains JavaScript
|
2022-03-01 08:37:56 -08:00
|
|
|
+ contains cookies
|
2022-02-19 05:08:42 -08:00
|
|
|
+ contains ads
|
|
|
|
|
+ has been heavily modified
|
|
|
|
|
|
2022-02-17 12:56:04 -08:00
|
|
|
# Features
|
|
|
|
|
+ Ad free
|
|
|
|
|
+ JavaScript free
|
2022-02-20 14:06:07 -08:00
|
|
|
+ Cookie free
|
2022-03-01 08:37:56 -08:00
|
|
|
+ Torrent results
|
|
|
|
|
+ Supports special queries (e.g.: 1 btc to usd , what does xyz mean etc.)
|
2022-02-17 12:56:04 -08:00
|
|
|
+ Tracking snippets from URLs are removed
|
|
|
|
|
+ Image results are converted to base64 to prevent clients from connecting to Google servers
|
|
|
|
|
+ Supports both POST and GET requests
|
2022-02-20 14:06:07 -08:00
|
|
|
+ YouTube results are converted into a privacy friendly Invidious instance
|
2022-03-01 08:37:56 -08:00
|
|
|
+ Easy to use JSON API for developers
|
2022-02-17 12:56:04 -08:00
|
|
|
+ No 3rd party libs are used
|
|
|
|
|
+ Easy to setup
|
|
|
|
|
|
|
|
|
|
# Hosting
|
|
|
|
|
Hosting LibreX should be easy since no 3rd party libs are used.<br/>
|
|
|
|
|
All you need is a webserver (e.g.: nginx) and PHP, and you are good to go.
|
|
|
|
|
|
|
|
|
|
# API
|
2022-02-20 14:06:07 -08:00
|
|
|
Example API request: `.../api.php?q=gentoo&p=2&type=0` <br/>
|
2022-02-25 01:42:32 -08:00
|
|
|
Where `q` is the keyword, `p` is the result page (the first page is `0`) and `type` is the search type (`0`=text, `1`=image, `2`=video, `3`=torrent)
|
2022-02-17 12:56:04 -08:00
|
|
|
<br/><br/>
|
|
|
|
|
JSON result:
|
|
|
|
|
+ In case of text search:
|
|
|
|
|
+ `title`: Title of the result site
|
|
|
|
|
+ `url`: Full URL of the result
|
|
|
|
|
+ `base_url`: The base URL of the result (e.g.: http://example.com/test.php -> http://example.com/)
|
|
|
|
|
+ In case of image search:
|
|
|
|
|
+ `base64`: The result image converted to base64 format
|
|
|
|
|
+ `alt`: The description of the image
|
2022-02-20 14:06:07 -08:00
|
|
|
+ In case of video search:
|
|
|
|
|
+ `title`: Title of the result video
|
|
|
|
|
+ `url`: Full URL of the video
|
|
|
|
|
+ `base_url`: The base URL of the result (e.g.: http://youtube.com/watch -> http://youtube.com/)
|
2022-02-25 01:42:32 -08:00
|
|
|
+ In case of torrent search:
|
|
|
|
|
+ `hash`: Hash of the torrent
|
|
|
|
|
+ `name`: Name of the torrent
|
|
|
|
|
+ `seeders`: The amount of seeders
|
|
|
|
|
+ `leechers`: The amount of leechers
|
2022-02-25 11:29:26 -08:00
|
|
|
+ `size`: The size of the files in human readable format
|
|
|
|
|
+ `source`: Where the torrent was fetched from
|
2022-02-25 01:42:32 -08:00
|
|
|
+ `magnet`: The magnet link
|
2022-02-17 12:56:04 -08:00
|
|
|
|
|
|
|
|
<br/>
|
|
|
|
|
The API also supports both GET and POST requests
|
|
|
|
|
|
2022-02-17 13:02:13 -08:00
|
|
|
# Donate
|
|
|
|
|
Monero (XMR): `41dGQr9EwZBfYBY3fibTtJZYfssfRuzJZDSVDeneoVcgckehK3BiLxAV4FvEVJiVqdiW996zvMxhFB8G8ot9nBFqQ84VkuC`
|
