commit be45fc45968486e8669bbe0eed0163e5c853a640 parent c858691814aadb66868f19244794bb1b47d5f0a1 Author: Remco van 't Veer <remco@remworks.net> Date: Tue, 27 Oct 2020 17:02:13 +0100 Describe procedure to get gus up and running Signed-off-by: Natalie Pendragon <natpen@natpen.net> Diffstat:
| M | README.md | | | 30 | ++++++++++++++++++++++++++++++ |
1 file changed, 30 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -1,5 +1,35 @@ # Gemini Universal Search (GUS) + +## Dependencies + +1. Install python and poetry +2. Run: "poetry install" + + +## Making an initial index + +Make sure you have some gemini URLs for testing which are nicely +sandboxed to avoid indexing huge parts of the gemini space. + +1. Create a "seed-requests.txt" file with you test gemini URLs +2. Run: "poetry run crawl -d" +3. Run: "poetry run build_index -d" + +Now you'll have created `index.new` directory, rename it to `index`. + + +## Running the frontend + +1. Run: "poetry run serve" +2. Navigate your gemini client to: "gemini://localhost/" + + +# Updating the index + +TODO + + ## Roadmap / TODOs - **log output of crawl**: I see some errors fly by, and it