Sign inSign up

temthelem/araa-search

By temthelem

Updated 7 months ago

Public Docker image for Araa Search (formerly TailsX). https://github.com/TEMtheLEM/araa-search

Image
1

10K+

temthelem/araa-search repository overview

About this image

This is a public image for Araa Search, a privacy respecting, self-hosted and ad-free FOSS metasearch engine.

If you're interested in the configuration, read #Configuring below.

All you need to do to use this image is to;

  • Pull it.
  • Configure any required (and optional!) environmental vars.
  • Run the image (preferably with docker-compose).

Note that nginx setup is not done in this image whatsoever. If you plan on using a reverse-proxy like nginx (which you should), you can learn about the recommended settings here.

Image maintained by TEMtheLEM (that's me). I do not own Araa Search (Extravi does), and the owner does not hold any responsibility for this image. Issues with the image should be reported to me here. Please include a reference to Docker in the title of your issue; something like [DOCKER] <your issue title here> would be sufficient enough.

Tags

Tags are latest or some commit SHA.

Some images are tagged with -alpine at the end. These images are identical to their non-"-alpine" variants; they only exist because of the migration from using Ubuntu as a base to Alpine.

If you're looking to live on the bleeding edge, use the beta tag. These images are really only for testing. Things may break.

Configuring (Environmental Variables)

You can configure the following environmental variables;

Variable nameRequired/OptionalDefaultDescription
DOMAINrequiredN/AThe domain of your instance. An example domain would look like; DOMAIN=tailsx.domain.com. This is required as the /opensearch.xml will be generated using it.
PORToptional8000The port the Python web server will run on.
WORKERSoptional8The number of workers the web server will use.
THREADSoptional2The number of threads the web server will use.
SHEBANGoptional!The 'shebang' to use for all of the shebang macros. Shebangs allow people to switch to another search engine through Araa Search. Something like !ddg cats will redirect the user to DuckDuckGo with their results for cats.
DONATE_URLoptionalhttps://github.com/sponsors/ExtraviThis URL can be used to direct users on where to donate to support anyone of your choosing. It, by default, directs users to Araa Search's creator's donation page.
DEFAULT_METHODoptionalGETThe default method users will use while using the instance.
DEFAULT_AC_ENGINEoptionalgoogleThe autocomplete engine users of the instance will use by default.
DEFAULT_LANGoptionalenglishThe language the instance will use by default.
DEFAULT_THEMEoptionaldark_blurThe name of the CSS theme to default to. The value will be used to load a CSS file named after the value. So dark_blur will load /static/css/dark_blur.css. All other themes are found under /static/css/. Every CSS file in that directory (except a few) is a valid theme.
ENABLE_APIoptionalFalseA boolean value indicating if the API should be enabled. This variable will enable/disable both the search results API and the search suggestions API.
PIPED_INSTANCEoptionalyt.ttj.devThe domain of the Piped (a YouTube proxy) instance the videos tab should use.
PIPED_APIoptionalytapi.ttj.devThe domain of the Piped API Araa will interact with (to get videos & video metadata).
PIPED_PROXYoptionalytproxy.ttj.devThe domain Araa will use to proxy videos through Piped.
ENABLE_TORRENTSoptionalTrueA boolean value indicating if the torrent search should be enabled.
TORRENTGALAXY_DOMAINoptionaltorrentgalaxy.toThe domain of the Torrent Galaxy site to use.
NYAA_DOMAINoptionalnyaa.siThe domain of the Nyaa Torrents site to use.
APIBAY_DOMAINoptionalapibay.orgAPI Bay's domain.
RUTOR_DOMAINoptionalrutor.infoRutor's domain.
TORRENT_SITESoptional[ 'nyaa', 'torrentgalaxy', 'tpb', 'rutor']A list consisting of what torrent sites should be used.
ENGINE_RATELIMIT_COOLDOWNoptional28The time, in minutes, an engine will be put on a 'cooldown' if/when it gets rate-limited.
DEFAULT_ENGINEoptionalgoogleThe default search engine to use if the client doesn't state any preference. You can choose google or qwant.

Tag summary

Content type

Image

Digest

sha256:a57b42afe

Size

37.4 MB

Last updated

over 1 year ago

docker pull temthelem/araa-search