58bd93dbd0 | ||
---|---|---|
app | ||
.dockerignore | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
opensearch.py | ||
requirements.txt | ||
run.sh | ||
server.py |
README.md
Shoogle
Get Google search results, but without any ads, javascript, or AMP links. Easily deployable via Docker, and customizable with a single config text file. Quick and simple to integrate as a primary search engine replacement on both desktop and mobile.
Prerequisites
- Docker (Windows, macOS, Ubuntu, other Linux distros)
- A Heroku Account
- Optional, but recommended. Allows for free hosting of the web app.
- Alternatively, you can host the app using a different service, or deploy it to your own server (explained below).
- Heroku CLI
Setup
- Ensure the Docker daemon is running, and is accessible by your user account
- To add user permissions, you can execute
sudo usermod -aG docker yourusername
- Running
docker ps
should return something besides an error. If you encounter an error saying the daemon isn't running, trysudo systemctl start docker
(Linux) or ensure the docker tool is running (Windows/macOS).
- Clone and deploy the docker app using a method below:
A) Using Heroku (Free)
heroku login
heroku container:login
git clone https://github.com/benbusby/shoogle.git
cd shoogle
heroku create
heroku container:push web
heroku container:release web
heroku open
Now you're done! This series of commands can take a while, but once you run it once, you shouldn't have to run it again. The final command, heroku open
will launch a tab in your web browser, where you can test out Shoogle and even set it as your primary search engine.
B) Using your own server, or alternative container deployment
There are other methods for deploying docker containers that are well outlined in this article, but there are too many to describe set up for each here. Generally it should be about the same amount of effort as the Heroku deployment.
Depending on your preferences, you can also deploy the app yourself on your own infrastructure. This route would require a few extra steps:
- A server (I personally recommend Digital Ocean or Linode, their cheapest tiers will work fine)
- Your own URL (I suppose this is optional, but recommended)
- SSL certificates (free through Let's Encrypt)
- A bit more experience or willingness to work through issues
Usage
Same as most search engines, with the exception of filtering by time range.
To filter by a range of time, append ":past
Extra Steps
Set Shoogle as your primary search engine
- From the main shoogle folder, run
python opensearch.py "\<your app url\>"
- Rebuild and release your updated app
heroku container:push web
and thenheroku container:release web
- Update browser settings
- Firefox (Desktop)
- Navigate to your app's url, and click the 3 dot menu in the address bar. At the bottom, there should be an option to "Add Search Engine". Once you've clicked this, open your Firefox Preferences menu, click "Search" in the left menu, and use the available dropdown to select "Shoogle" from the list.
- Firefox (Mobile)
- In the mobile app Settings page, tap "Search" within the "General" section. There should be an option titled "Add Search Engine" to select. It should prompt you to enter a title and search query url - use the following elements to fill out the form:
- Title: "Shoogle"
- URL: "https://<your shoogle url>/search?q=%s"
- In the mobile app Settings page, tap "Search" within the "General" section. There should be an option titled "Add Search Engine" to select. It should prompt you to enter a title and search query url - use the following elements to fill out the form:
Customizing and Configuration
Shoogle currently allows a few minor configuration settings, accessible from the home page:
- "Near"
- Set to a city name to narrow your results to a general geographic region. This can be useful if you rely on being able to search for things like "pizza places" and see results in your city, rather than results from wherever the server is located.
- Dark Mode
- Sets background to pure black
- NoJS Mode (Experimental)
- Adds a separate link for each search result that will open the webpage without any javascript content served. Can be useful if you're seeking a no-javascript experience on mobile, but otherwise could just be accomplished with a browser plugin.