From 7df4b38d090fafbe29fb9f6661c9a0d4a1a0fcc6 Mon Sep 17 00:00:00 2001 From: gibbyb Date: Fri, 28 Feb 2025 15:02:19 -0600 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d01b319..07652bc 100644 --- a/README.md +++ b/README.md @@ -18,21 +18,11 @@ This fork allows anyone to easily self host this service & add bangs for their o *Note: We have replaced some of the default bangs from duckduckgo with our own bangs in order to have more simple bangs for the self-hosted websites.* +All you have to do is fill out the environment variables in the .env.example files located in the root directory & the docker directory & rename them to .env. + You can also easily add your own bangs by adding a new entry in the bangs.ts file. -DuckDuckGo's bang redirects are too slow. Add the following URL as a custom search engine to your browser. Enables all of DuckDuckGo's bangs to work, but much faster. - -``` -https://bang.gbrown.org?q=%s -``` - -## How is it that much faster? - -DuckDuckGo does their redirects server side. Their DNS is...not always great. Result is that it often takes ages. - -Theo solved this by doing all of the work client side. Once you've went to https://unduck.link once, the JS is all cache'd and will never need to be downloaded again. Your device does the redirects, not me. - -### How to self host +## How to self host 1. Clone the repo & fill out the .env.example files in the root directory & the docker directory & rename them to .env. - *Note: Our docker compose assumes you plan to select an external network.* @@ -43,3 +33,13 @@ Theo solved this by doing all of the work client side. Once you've went to https 1. Run the bash script `update-bang` in the docker directory with the root directory of the project as an argument. - *Note: You can also simply run it from the root or docker directory without an argument.* + +## Theo's words + +DuckDuckGo's bang redirects are too slow. Add the following URL as a custom search engine to your browser. Enables all of DuckDuckGo's bangs to work, but much faster. + +### How is it that much faster? + +DuckDuckGo does their redirects server side. Their DNS is...not always great. Result is that it often takes ages. + +Theo solved this by doing all of the work client side. Once you've went to https://unduck.link once, the JS is all cache'd and will never need to be downloaded again. Your device does the redirects, not me.