Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: spirillen <[email protected]>
  • Loading branch information
spirillen authored Jan 23, 2025
1 parent 3c2011c commit 9f4a4b5
Showing 1 changed file with 41 additions and 26 deletions.
67 changes: 41 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,41 @@
# Yggdrasil

This projects aim's to replace [hosts-sources](https://github.com/external-sources/hosts-sources) as it is an outdated
and unpractical way to collect, store and search for records.

## Goals

1. Import external sources, such as hosts, json, plain text files and MariaDB
2. Load the data into some Database; this could be json, CSV or MariaDB.
3. Sort by first domain, then URI, at last by category.
4. Keep track of the sources for domain and URI records
5. Make a search command that can sort and list results
1. Sort output by source, then records
2. Sort output sorted (clean format), no sources
3. Output from none DNS sources like EasyList, uBlock and Adguard.
4. Output records from My Privacy DNS project [Matrix](https://github.com/mypdns/matrix)
5. Output MyPDNS RPZ records, extract directly from MariaDB
6. Manage Matrix records. (Add,Delete.Alter) to:
1. PowerDNS Auth server's API <https://docs.powerdns.com/authoritative/http-api/zone.html>
2. Alter the source files within the Matrix [source/](https://github.com/mypdns/matrix/tree/master/source)
directory.
7. Incorporate PyFunceble for availability test before committing
8. Future, working with a webcrawler that can categorize sites and scripts to search for primarily trackers and adult
sites
9. Add a GUI to manage all of this, rather than console as we also have to work with several categories per record.
1. Suggested to use gtk-rs, or maybe relm, which wraps gtk-rs (https://matrix.to/#/!ifW4td0it0scmZpEM6:computer.surgery/$PA9YBwGw53VA6HNePqQ4hrOIbVpWktIlrnytCOQRLZo?via=computer.surgery&via=matrix.org&via=mozilla.org)
# Omni Search

Welcome to **OmniSearch**, a powerful and comprehensive search tool brought to you by the **My Privacy DNS** project! Our mission is to enhance your search experience by aggregating results from multiple sources, allowing you to find information seamlessly across various platforms, applications, and repositories. With OmniSearch, we aim to streamline information retrieval and boost productivity, especially in enterprise environments.

## Project Overview

OmniSearch is designed to import external sources such as hosts, JSON files, plain text files, and MariaDB databases. We load this data into a flexible database format, including JSON, CSV, or MariaDB, and provide robust sorting and searching capabilities. Our tool keeps track of the sources for domain and URI records, ensuring that you have access to reliable and organized information.

### Key Features

- **Data Import**: Easily import data from various external sources, including hosts, JSON, plain text files, and MariaDB.
- **Flexible Database Loading**: Load data into JSON, CSV, or MariaDB formats for easy access and management.
- **Advanced Sorting**: Sort results by domain, URI, and category to find exactly what you need.
- **Source Tracking**: Keep track of the sources for domain and URI records for better transparency and reliability.
- **Search Command**: Execute search commands that sort and list results based on your preferences.
- Sort output by source, then records.
- Clean format output without sources.
- Output records from non-DNS sources like EasyList, uBlock, and Adguard.
- Access records from the My Privacy DNS project Matrix.
- Extract MyPDNS RPZ records directly from MariaDB.

### Record Management

We provide tools to manage Matrix records, allowing you to add, delete, or alter records through:

- **PowerDNS Auth Server's API**: Interact with the PowerDNS API for authoritative zone management. [API Documentation](https://docs.powerdns.com/authoritative/http-api/zone.html)
- **Source File Alteration**: Modify source files within the Matrix source directory for customized data management.

### Availability Testing

Before committing any changes, we incorporate **PyFunceble** to test the availability of domains, ensuring that your data remains accurate and up-to-date.

### Future Developments

We are actively working on integrating a web crawler that will categorize sites and scripts, primarily focusing on tracking and adult sites. This feature will further enhance our search capabilities and provide users with even more comprehensive results.

## Get Started

To get started with OmniSearch, visit our project page at [My Privacy DNS](http://www.mypdns.org) and explore the documentation for installation and usage instructions.

Join us in revolutionizing the way you search for information! With OmniSearch, we empower you to find what you need, when you need it, all in one place.

0 comments on commit 9f4a4b5

Please sign in to comment.