gib/Bang
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Gabriel Brown 2025-02-28 11:57:34 -06:00
parent c75f426065
commit 5d6e12c308
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -2,6 +2,16 @@
*This is a fork of [unduck](https://unduck.link) by [Theo](https://github.com/t3dotgg/unduck).* *This is a fork of [unduck](https://unduck.link) by [Theo](https://github.com/t3dotgg/unduck).*
## Why fork?
This fork allows anyone to easily self host this service & allows them to easily add bangs for their own self-hosted websites, & comes pre-configured to work with
- Searxng
- Gitea
- OpenWebUI
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. 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.
``` ```
@ -13,3 +23,16 @@ https://bang.gbrown.org?q=%s
DuckDuckGo does their redirects server side. Their DNS is...not always great. Result is that it often takes ages. 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. 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
1. Clone the repo
2. Fill out the .env.example file & rename it to .env
3. Run `pnpm install` from the root of the repo
4. Run `pnpm build` from the root of the repo
5. Navigate to the docker folder & run `docker-compose up -d`
### How to update the website
1. Run `pnpm build` from the root of the repo
2. Navigate to the docker folder & run `docker-compose up -d`