2023-03-27 17:25:27 +02:00
|
|
|
# Marginalia Search
|
2022-05-19 17:45:26 +02:00
|
|
|
|
2023-03-04 13:19:01 +01:00
|
|
|
This is the source code for [Marginalia Search](https://search.marginalia.nu).
|
2022-05-21 12:10:54 +02:00
|
|
|
|
2022-05-31 14:15:20 +02:00
|
|
|
The aim of the project is to develop new and alternative discovery methods for the Internet.
|
|
|
|
|
It's an experimental workshop as much as it is a public service, the overarching goal is to
|
2022-06-01 18:00:30 +02:00
|
|
|
elevate the more human, non-commercial sides of the Internet. A side-goal is to do this without
|
|
|
|
|
requiring datacenters and expensive enterprise hardware, to run this operation on affordable hardware.
|
2022-05-31 14:15:20 +02:00
|
|
|
|
2023-03-20 16:10:39 +01:00
|
|
|
## Set up
|
2022-05-31 14:15:20 +02:00
|
|
|
|
2023-04-02 14:43:14 +02:00
|
|
|
Start by running [⚙️ run/setup.sh](run/setup.sh). This will download supplementary model data that is necessary to run the code.
|
|
|
|
|
These are also necessary to run the tests.
|
2023-03-20 16:10:39 +01:00
|
|
|
|
2023-04-02 14:43:14 +02:00
|
|
|
To set up a local test environment, follow the instructions in [📄 run/readme.md](run/readme.md)!
|
2022-05-19 22:15:19 +02:00
|
|
|
|
2023-04-22 21:02:25 +02:00
|
|
|
## Hardware Requirements
|
|
|
|
|
|
|
|
|
|
A production-like environment requires at least 128 Gb of RAM and ideally 2 Tb+ of enterprise
|
|
|
|
|
grade SSD storage, as well as some additional terabytes of slower harddrives for storing crawl
|
|
|
|
|
data. It can be made to run on smaller hardware by limiting size of the index.
|
|
|
|
|
|
|
|
|
|
A local developer's deployment is possible with much smaller hardware (and index size).
|
|
|
|
|
|
2023-04-02 14:08:17 +02:00
|
|
|
## Project Structure
|
2022-05-30 16:48:11 +02:00
|
|
|
|
2023-04-02 14:08:17 +02:00
|
|
|
[📁 code/](code/) - The Source Code. See [📄 code/readme.md](code/readme.md) for a further breakdown of the structure and architecture.
|
|
|
|
|
|
|
|
|
|
[📁 run/](run/) - Scripts and files used to run the search engine locally
|
|
|
|
|
|
|
|
|
|
[📁 third-party/](third-party/) - Third party code
|
|
|
|
|
|
|
|
|
|
[📁 doc/](doc/) - Supplementary documentation
|
|
|
|
|
|
|
|
|
|
[📄 CONTRIBUTING.md](CONTRIBUTING.md) - How to contribute
|
|
|
|
|
|
|
|
|
|
[📄 LICENSE.md](LICENSE.md) - License terms
|
2022-05-30 16:48:11 +02:00
|
|
|
|
|
|
|
|
## Supporting
|
|
|
|
|
|
|
|
|
|
Consider [supporting this project](https://memex.marginalia.nu/projects/edge/supporting.gmi).
|
|
|
|
|
|
|
|
|
|
## Contact
|
|
|
|
|
|
2022-06-15 16:53:19 +02:00
|
|
|
You can email <kontakt@marginalia.nu> with any questions or feedback.
|
2023-04-02 14:08:17 +02:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
The bulk of the project is available with AGPL 3.0, with exceptions. Some parts are co-licensed under MIT,
|
|
|
|
|
third party code may have different licenses. See the appropriate readme.md / license.md.
|
