diff --git a/dev/search_api.html b/dev/search_api.html index 13ddba80..2b6e65f2 100644 --- a/dev/search_api.html +++ b/dev/search_api.html @@ -42,57 +42,123 @@

Search API

The search supports both GET and POST.

Furthermore, two enpoints / and /search are available for querying.

-
GET /
-
-
-
GET /search
-
-
+

GET /

+

GET /search

Parameters

- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription 
qThe search query, see Search syntaxrequired
categoriesComma separated list, specifies the active search categoriesoptional
enginesComma separated list, specifies the active search enginesoptional
langCode of the languageoptional (default: all)
pagenoSearch page numberoptional (default: 1)
time_rangeTime range of searchoptional (possible: day, month, year)
formatOutput format of resultsoptional (possible: json, csv, rss)
+
q
+
+
+

The search query. This string is passed to external search services. +Thus, searx supports syntax of each search service. For example, site:github.com searx is a valid +query for Google. However, if simply the query above is passed to any search engine which does not filter its +results based on this syntax, you might not get the results you wanted.

+

See more at Search syntax

+

Required.

+
categories
+
+
+

Comma separated list, specifies the active search categories

+

Optional.

+
engines
+
+
+

Comma separated list, specifies the active search engines.

+

Optional.

+
lang
+
+
+

Code of the language.

+

Optional.

+

Default: all

+
pageno
+
+
+

Search page number.

+

Optional.

+

Default: 1

+
time_range
+
+
+

Time range of search for engines which support it. See if an engine supports time range search in the preferences page of an instance.

+

Optional.

+

Possible: day, month, year

+
format
+
+
+

Output format of results.

+

Optional.

+

Possible: json, csv, rss

+
results_on_new_tab
+
+
+

Open search results on new tab.

+

Optional.

+

Default: 0

+

Possible: 0, 1

+
image_proxy
+
+
+

Proxy image results through searx.

+

Optional.

+

Default: False

+

Possible: True, False

+
autocomplete
+
+
+

Service which completes words as you type.

+

Optional.

+

Default: empty

+

Possible: google, dbpedia, duckduckgo, startpage, wikipedia

+
safesearch
+
+
+

Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance.

+

Optional.

+

Default: None

+

Possible: 0, 1, None

+
theme
+
+
+

Theme of instance.

+

Optional.

+

Default: oscar

+

Possible: oscar, simple, legacy, pix-art, courgette

+

Please note, available themes depend on an instance. It is possible that an instance administrator deleted, created or renamed themes on his/her instance. See the available options in the preferences page of the instance.

+
oscar-style
+
+
+

Style of Oscar theme. It is only parsed if the theme of an instance is oscar.

+

Optional.

+

Default: logicodev

+

Possible: pointhi, logicodev

+

Please note, available styles depend on an instance. It is possible that an instance administrator deleted, created or renamed styles on his/her instance. See the available options in the preferences page of the instance.

+
enabled_plugins
+
+
+

List of enabled plugins.

+

Optional.

+

Default: HTTPS_rewrite, Self_Informations, Search_on_category_select, Tracker_URL_remover

+

Possible: DOAI_rewrite, HTTPS_rewrite, Infinite_scroll, Vim-like_hotkeys, Self_Informations, Tracker_URL_remover, Search_on_category_select

+
disabled_plugins
+
+
+

List of disabled plugins.

+

Optional.

+

Default: DOAI_rewrite, Infinite_scroll, Vim-like_hotkeys

+

Possible: DOAI_rewrite, HTTPS_rewrite, Infinite_scroll, Vim-like_hotkeys, Self_Informations, Tracker_URL_remover, Search_on_category_select

+
enabled_engines
+
+
+

List of enabled engines.

+

Optional.

+

Possible: all engines

+
disabled_engines
+
+
+

List of disabled engines.

+

Optional.

+

Possible: all engines

diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst index 331bc4eb..ea3b0501 100644 --- a/docs/dev/search_api.rst +++ b/docs/dev/search_api.rst @@ -5,31 +5,200 @@ The search supports both ``GET`` and ``POST``. Furthermore, two enpoints ``/`` and ``/search`` are available for querying. -.. code:: sh - GET / +``GET /`` -.. code:: sh - - GET /search +``GET /search`` Parameters -`````````` +~~~~~~~~~~ -+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+ -| Name | Description | | -+==================+====================================================================================================+==================================================+ -| ``q`` | The search query, see :doc:`/user/search_syntax` | required | -+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+ -| ``categories`` | Comma separated list, specifies the active search categories | optional | -+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+ -| ``engines`` | Comma separated list, specifies the active search engines | optional | -+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+ -| ``lang`` | Code of the language | optional (default: ``all``) | -+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+ -| ``pageno`` | Search page number | optional (default: ``1``) | -+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+ -| ``time_range`` | Time range of search | optional (possible: ``day``, ``month``, ``year``)| -+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+ -| ``format`` | Output format of results | optional (possible: ``json``, ``csv``, ``rss``) | -+------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+ +.. code:: sh + + q + +The search query. This string is passed to external search services. +Thus, searx supports syntax of each search service. For example, ``site:github.com searx`` is a valid +query for Google. However, if simply the query above is passed to any search engine which does not filter its +results based on this syntax, you might not get the results you wanted. + + +See more at :doc:`/user/search_syntax` + +Required. + +.. code:: sh + + categories + +Comma separated list, specifies the active search categories + +Optional. + +.. code:: sh + + engines + +Comma separated list, specifies the active search engines. + +Optional. + +.. code:: sh + + lang + +Code of the language. + +Optional. + +Default: ``all`` + +.. code:: sh + + pageno + +Search page number. + +Optional. + +Default: ``1`` + +.. code:: sh + + time_range + +Time range of search for engines which support it. See if an engine supports time range search in the preferences page of an instance. + +Optional. + +Possible: ``day``, ``month``, ``year`` + +.. code:: sh + + format + +Output format of results. + +Optional. + +Possible: ``json``, ``csv``, ``rss`` + +.. code:: sh + + results_on_new_tab + +Open search results on new tab. + +Optional. + +Default: ``0`` + +Possible: ``0``, ``1`` + +.. code:: sh + + image_proxy + +Proxy image results through searx. + +Optional. + +Default: ``False`` + +Possible: ``True``, ``False`` + +.. code:: sh + + autocomplete + +Service which completes words as you type. + +Optional. + +Default: empty + +Possible: ``google``, ``dbpedia``, ``duckduckgo``, ``startpage``, ``wikipedia`` + +.. code:: sh + + safesearch + +Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance. + +Optional. + +Default: ``None`` + +Possible: ``0``, ``1``, ``None`` + +.. code:: sh + + theme + +Theme of instance. + +Optional. + +Default: ``oscar`` + +Possible: ``oscar``, ``simple``, ``legacy``, ``pix-art``, ``courgette`` + +Please note, available themes depend on an instance. It is possible that an instance administrator deleted, created or renamed themes on his/her instance. See the available options in the preferences page of the instance. + +.. code:: sh + + oscar-style + +Style of Oscar theme. It is only parsed if the theme of an instance is ``oscar``. + +Optional. + +Default: ``logicodev`` + +Possible: ``pointhi``, ``logicodev`` + +Please note, available styles depend on an instance. It is possible that an instance administrator deleted, created or renamed styles on his/her instance. See the available options in the preferences page of the instance. + +.. code:: sh + + enabled_plugins + +List of enabled plugins. + +Optional. + +Default: ``HTTPS_rewrite``, ``Self_Informations``, ``Search_on_category_select``, ``Tracker_URL_remover`` + +Possible: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, ``Search_on_category_select`` + +.. code:: sh + + disabled_plugins + +List of disabled plugins. + +Optional. + +Default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys`` + +Possible: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, ``Search_on_category_select`` + +.. code:: sh + + enabled_engines + +List of enabled engines. + +Optional. + +Possible: all engines + +.. code:: sh + + disabled_engines + +List of disabled engines. + +Optional. + +Possible: all engines diff --git a/searchindex.js b/searchindex.js index cfe772cb..182eb196 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["admin/api","admin/filtron","admin/morty","blog/admin","blog/blog","blog/python3","dev/contribution_guide","dev/engine_overview","dev/install/installation","dev/plugins","dev/quickstart","dev/search_api","dev/translation","index","user/own-instance","user/search_syntax"],envversion:52,filenames:["admin/api.rst","admin/filtron.rst","admin/morty.rst","blog/admin.rst","blog/blog.rst","blog/python3.rst","dev/contribution_guide.rst","dev/engine_overview.rst","dev/install/installation.rst","dev/plugins.rst","dev/quickstart.rst","dev/search_api.rst","dev/translation.rst","index.rst","user/own-instance.rst","user/search_syntax.rst"],objects:{},objnames:{},objtypes:{},terms:{"boolean":7,"break":6,"byte":7,"case":[8,10,14],"default":[1,2,5,6,8,9,11,13,14,15],"function":[7,9],"import":8,"int":7,"long":14,"new":[3,6,9,10,12],"null":8,"public":13,"return":[9,14],"short":10,"static":9,"switch":6,"true":[0,1,7,8,9,10],"try":[10,14],But:[3,5,7,14],For:[1,6,8,10],IPs:1,One:3,The:[0,6,7,8,11,14],Then:[5,10,12],There:6,These:7,Use:1,a2enmod:8,abbrev:15,abl:[6,7],about:[6,8,13],abov:[6,8],abus:[1,14],accept:15,access:[1,3,14],access_log:8,account:12,act:[2,3],action:[0,1],activ:[2,5,8,10,11],adapt:7,add:[2,6,8,9,15],added:9,addit:[7,8],addition:[13,14],address:[2,7,14],admin:4,administr:[3,14],adopt:6,ads:14,advantag:3,advertis:14,advis:[1,8],affect:3,after:[5,9,10,12],agent:[1,7],aggreg:[1,13,14],ahrefsbot:1,aim:3,all:[0,2,5,6,7,11],allow:[8,15],along:1,alreadi:6,also:[6,8,14,15],alter:6,alwai:[7,10,14],among:[6,14],ani:13,anonym:[13,14],anoth:[3,7],answer:14,anyon:13,anyth:[5,14],apache2:8,api:[7,12,13],api_kei:7,app:8,appear:10,appli:[6,8],applic:[1,3,8],appropri:6,apt:[8,10],arbitrari:7,arch:0,archiv:1,argument:2,arrai:7,asciimoo:[8,10,12],aspect:6,assign:7,attach:9,author:6,auto:12,autocomplet:0,avail:[8,10,11,14],avoid:1,back:8,baiduspid:1,ban:14,bar:13,barrier:3,base:7,base_url:[7,8],bash:8,becaus:[3,6,7,10,12,14],befor:[5,9,10,14],behaviour:[6,9],being:[1,3,5,13],below:[1,6,8,10,12],besid:14,best:14,better:[7,8,14],between:7,biggest:3,bin:[5,8,10],bingbot:1,bitbucket:0,block:1,born:6,bot:1,both:[5,6,11,14],botlimit:1,boundingbox:7,branch:6,browser:[4,5,6,14],bug:10,bugreport:6,build:[6,8],build_grunt:10,built:[6,7,10],call:[3,12],callback:9,can:[0,1,2,3,5,6,7,8,9,10,13,14],cannot:14,capabl:[3,6],captcha:14,caption:[],categori:[0,7,11,15],certif:8,chainabl:15,chang:[5,8],chapter:6,charact:6,chdir:8,check:[6,7,10,12],checkout:6,chmod:8,choic:14,choos:[6,7],chown:8,citi:7,clear:14,cli:[10,12],client:1,clone:[8,10],code:[8,10,11,14],codebas:3,com:[3,7,8,10,12],combin:8,come:[1,5,6,14],comma:11,command:[1,5,8,10,12],commit:[10,12],common:[10,14],compani:14,compat:5,compil:12,compon:9,compromis:14,comput:14,concern:6,conf:8,config:[0,7,8,12],configur:[3,12,14],connect:13,consequ:6,construct:7,consult:10,contain:10,content:14,context:9,contribut:13,control:14,convent:6,cooki:[7,13,14],corner:6,could:7,count:8,countri:7,coupl:8,coverag:10,cpu:8,creat:[5,6,8,10,12],cryptic:10,css:9,css_depend:9,csv:[1,11],cthulhu:15,ctx:9,curl:1,current:[6,7,15],custom:[6,15],customiz:[0,3],customlog:8,dai:11,data:[7,14],date:[0,7],datetim:7,daunt:3,ddg:15,debian:8,debug:8,decid:3,decim:7,def:[7,9],default_local:0,default_on:9,default_them:0,defin:9,delet:12,demon:8,depen:1,depend:[3,5,7,8,10],deploi:8,descript:[9,11],deserv:6,desir:[7,10],deutsch:0,dev:8,develop:[3,5,6],differ:[5,6,7],digit:13,disabl:9,disrespect:6,dive:14,dockerfil:8,doe:[3,7],domain:8,domin:6,don:[5,13],drop:5,duckduckgo:15,easi:13,easili:6,edit:[3,6,8,14],effect:6,either:10,elimin:10,emb:13,embed:[0,8],en_u:7,enabl:[0,6,8,10],encrypt:13,engin:[0,3,6,10,11,13,14,15],english:0,enough:12,enpoint:11,enter:[5,8],error:10,error_log:8,esperanto:0,essenti:8,etc:[1,6,8],everi:[7,14],everyon:14,everyth:[8,14],exactli:1,exampl:[0,1,8,10,14],exceed:1,except:[5,6],exchang:14,execut:12,exist:[3,6],exit:8,expect:6,experienc:3,explain:6,extend:[6,9],extens:6,extern:[1,2,7,14],extrem:3,fail:10,fals:[0,8,9,10],fanci:6,featur:[2,3,6,14],feedback:6,feedfetch:1,feel:9,few:[6,7],file:[3,5,6,8,9,10,12],file_filt:12,filenam:7,files:7,filter:[0,1],find:1,fine:8,finish:12,firewal:1,first:[3,5,10,14],fit:9,fix:[6,10],flask:9,folder:[6,7,10,12],follow:[1,2,6,7,10,12],followsymlink:8,fork:6,form:[0,14],format:[1,7,10,11],forward:[1,8,14],found:[1,3],foundat:[3,5],free:[8,9,13],friend:14,friendli:[],from:[1,4,5,6,12,13,14],fulli:3,further:10,furthermor:[7,10,11,14],gain:14,gener:[0,6,14],geojson:7,german:0,get:[6,7,8,10,11,12,13],gid:8,git:[8,10],github:[3,5,8,10],give:10,goi:0,going:[1,14],good:[6,10],googl:0,googlebot:1,grant:8,graphic:3,group:14,grow:3,grunt:10,gui:[],guid:[3,10],hack:[3,5,6],hackerspac:15,handl:14,handler:8,happi:[3,5,6],hard:3,has:[2,6,7,10,14],have:[3,5,6,7,8,14],header:[1,7],help:[6,10],her:14,hex:8,hidden:[0,14],his:14,home:12,host:[1,3,12,13],hotkei:0,hour:8,hous:7,house_numb:7,how:13,howev:7,html:[0,6,7],http:[0,1,2,3,7,8,10,12,13],http_host:1,hub:8,idea:10,imag:[0,2,15],img_src:7,implement:[3,5,6,7,9],includ:8,inclus:15,index:8,inform:[1,2,6,7,8],ini:8,init:8,initi:12,input:0,insert:12,insid:7,insight:14,instal:[1,2,5,6,10,12,13],instanc:[0,4,8,12,13],instance_nam:0,instead:[3,5,10],integr:13,intent:6,interfac:4,interfer:6,intern:10,internet:13,interpret:8,interpretor:8,interv:1,introduc:[3,4],introduct:10,investig:5,iso:7,issu:5,its:[3,6,14],itself:6,jame:1,js_depend:9,json:[1,11],just:[0,14],kei:[2,7,12],kind:14,know:14,kvch:[3,5],lack:6,lang:[0,11,12],languag:[0,7,11,12,15],language_support:7,laptop:14,lat:7,latest:12,latitud:7,lazi:8,lc_messag:12,least:5,leech:7,leecher:7,length:6,less:[3,10,14],let:14,level:6,libapache2:8,libffi:8,libssl:8,libxslt:8,light:8,like:[0,7,8],limit:1,line:6,linkdexbot:1,linux:0,list:[7,9,11,15],listen:[1,8],local:[0,5,7,8,9,10,12],localhost:8,locat:[1,8],log:[10,14],lon:7,longitud:7,low:8,magnetlink:7,main:12,make:[3,5,8,14],manag:[4,8,10],mani:1,manipul:3,map:0,mass:6,master:8,matter:[7,14],max:[1,7],maxim:6,maximum:[6,7],mean:14,media:[0,7],mention:5,messag:[1,10,12],messagespo:12,metasearch:[7,13],method:[0,7],might:[6,14],migrat:5,min:7,misbehav:6,mj12bot:1,mod:8,modifi:15,modul:8,monet:14,month:[0,11],more:[2,3,6,8,13,14],morti:2,most:[5,14],msnbot:1,multibl:7,multipl:14,must:[5,6,7,10],myproject:10,name:[0,1,7,8,9,11,12],necessari:8,need:[6,14],neither:13,net:13,netvib:1,newcom:3,nginx:1,nlnet:[3,5],node:10,nodej:10,none:7,nor:13,normal:7,note:[6,8],now:[5,9],npm:10,number:[1,7,8,11],number_of_result:7,object:[7,9],off:[6,8],often:7,okhin:8,on_result:9,one:[13,14],ones:7,onli:[2,8,9],onlin:13,open:[5,14],openssl:8,openstreetmap:0,oper:[5,14],option:[2,3,7,8,9,10,11,14],order:[6,10],org:7,org_bot:1,organis:13,origin:8,oscar:0,osm:[0,7],other:[6,7,14],otherwis:7,our:3,out:6,output:11,over:13,overview:13,overwritten:7,own:[13,14],packag:[8,10],page:[1,3,6,7,11,14,15],pageno:[7,11],pagenumb:7,param:[1,7],paramet:7,paramt:7,part:3,parti:14,partli:7,past:0,patch:6,path:[1,8],peopl:[3,14],pep8:[6,10],per:7,perform:7,phase:10,pip3:5,pip:[6,12],place:[6,7,14],pleas:[5,6,8,10],plenti:6,plugin:[0,6,8,13],point:[8,14],port:[1,8],possibl:[2,8,11],post:[0,6,8,11],post_search:9,postcod:7,pot:12,pre_search:9,prefer:[3,14,15],prefix:15,preserv:6,preview:7,privaci:8,privat:13,problem:1,proce:8,process:1,profil:[13,14],project:1,promot:13,proper:14,properli:5,protect:[6,13],provid:[6,7],proxi:[8,13,14],proxifi:2,proxy_add_x_forwarded_for:[1,8],proxy_buff:8,proxy_pass:[1,8],proxy_set_head:[1,8],publish:7,publishedd:7,pull:[6,8,12],purpos:7,pybabel:[8,12],python2:5,python3:4,python:[1,5,8],pythonpath:8,quadratur:13,queri:[0,7,11,14,15],question:14,quickstart:[6,13],quit:6,qwer:15,rand:8,random:[7,14],rang:[7,11],rate:1,readm:2,real:1,reason:3,recommend:7,reconsid:6,redefin:7,reduc:6,refer:[13,14],regardless:14,rememb:6,remote_addr:1,remov:14,replac:[3,9],repo:6,repositori:[3,8],request:[6,9,14],requir:[5,6,7,10,11],reset:14,respect:[6,14],restart:[2,8],result:[11,13,14],result_proxi:2,retriev:12,revers:8,rewrit:[0,8],right:[8,9,13],road:7,roboag:1,robotframework:5,root:8,round:6,rss:[1,11],rst:6,rule:1,run:[1,2,8,9,12,14],safe_search:0,same:[1,7],satisfi:10,scheme:[1,8],scrapi:1,script:[1,8,10],script_nam:8,search:[1,6,7,13,14],search_path:7,search_str:7,searx:[0,1,2,4,6,7,9,10,12,15],sec:1,secur:13,sed:8,see:[2,6,8,11,13,15],seed:7,seeder:7,select:[14,15],selenium:10,self:[3,13],send:[1,14],sent:14,separ:[6,11],serv:14,server:10,server_nam:8,servic:[1,2,8,13,14],set:[2,3,8,10,12,13,14],sethandl:8,setup:[8,13],seznambot:1,she:14,shortcut:[0,7],should:[3,5,6,8,12],simpli:6,sinc:3,singl:[8,14],site:[0,7,8],size:7,skip:10,slurp:1,small:7,smtbot:1,snippet:2,social:0,socket:8,sold:14,solv:1,some:8,someon:14,someth:6,sometim:3,sourc:[5,12,14],source_fil:12,source_lang:12,special:7,specif:[7,8],specifi:[7,11],sphinx:6,splinter:5,sponsor:[3,5],ssl:[7,8,13],stack:10,standalon:3,standard:[6,7],start:[1,6,7,8,13],stash:8,step:[6,8],stop:1,store:[7,14],street:7,string:[7,12],submit:6,subrul:1,sudo:[8,10],suggest:9,supervisor:3,support:[4,6,7,11,13,14],sure:[5,8],syntax:[11,13],system:[5,6],tailor:14,take:[3,6],tell:7,templat:7,test:[5,6,8],text:[0,7],than:13,thei:14,thi:[1,2,3,5,7,8,9,10,14],think:6,third:14,those:[12,14],thread:8,three:[6,9,14],through:14,thu:[5,14],thumbnail:7,thumbnail_src:7,time:[1,5,7,11,14],time_rang:[0,11],time_range_support:7,timeout:7,titl:7,tld:8,too:[1,14],tool:[3,6,12],tor:[13,14],torrentfil:7,trace:10,track:[13,14],traffic:8,transifex:6,transifexrc:12,translat:13,travi:[5,10],trust:[13,14],try_fil:8,tupl:9,turn:[6,10],twice:8,two:[6,11],txt:[5,6],type:[0,7,12,14],ubuntu:8,ugli:3,uid:8,ultrasecretkei:8,uncommon:6,under:[6,7],understand:3,unfortun:6,unit:[6,10],unit_test:10,univers:8,unix:8,unknown:14,unlik:14,unspecifi:7,updat:6,update_dev_packag:10,update_packag:8,uri:8,url:[0,2,7,14],urlencod:7,usag:3,use:[2,6,7,8,13],used:[5,6,7,8,13,14],user:[1,6,7,8,14],useradd:8,userag:1,uses:[7,14],using:[1,6,8,10,12,13],usr:8,usual:[5,8,14],uwsgi_modifier1:8,uwsgi_param:8,uwsgi_pass:8,uwsgisocket:8,valid:[7,10],valu:[0,7],variabl:7,variou:[6,9],vendor:6,venv3:5,verifi:7,version:5,via:[3,15],view:14,vim:0,virtual:8,virtualenv:[5,8,10],visit:14,vpn:14,vulner:14,wai:[6,7,14],want:[5,14],warn:8,web:3,webapp:[5,8],webcrawl:1,websit:0,weird:6,were:5,wget:1,whatev:8,when:[5,9,10,14],where:1,whether:[10,14],which:[1,3,6,7,13,14],who:[3,8,14],whole:[8,9],why:13,wide:6,wiki:0,wikipedia:15,wish:6,without:[7,13,14],won:5,wonderfal:8,word:9,work:[6,7,8,10,14],worker:8,world:[6,14],worri:5,worth:14,wsgi:8,www:12,yacybot:1,yahoo:1,yandexbot:1,yandexmobilebot:1,year:11,yet:7,yml:[2,3,8,10],you:[6,8,10,13,14,15],your:[2,4,5,6,8,9,13],your_morty_proxy_kei:2,yourself:6,zgrab:1,zlib1g:8},titles:["Administration API","How to protect an instance","How to setup result proxy","Searx admin interface: manage your instance from your browser","Blog","Introducing Python3 support","How to contribute","Engine overview","Installation","Plugins","Development Quickstart","Search API","Translation","Welcome to searx","Why use a private instance?","Search syntax"],titleterms:{"default":7,"new":[],"public":14,"return":7,about:14,acknowledg:[3,5],admin:3,administr:[0,13],apach:8,api:[0,11],argument:7,bar:0,basic:8,blog:4,browser:3,bug:5,build:10,check:8,code:[6,7],compil:10,conclus:14,configur:[0,1,7,8],consequ:14,content:[7,8],contribut:6,data:0,debug:10,design:6,develop:[10,13],direct:6,disabl:8,docker:8,document:[6,13],doe:14,emb:0,engin:7,entri:9,environ:10,exampl:[7,9,15],fact:5,featur:13,file:7,filtron:1,found:5,from:[3,8],fun:5,gener:7,get:0,hackabl:6,hook:9,host:8,how:[1,2,5,6,8,10,14],imag:7,init:12,instal:[3,8],instanc:[1,3,14],interfac:3,introduc:5,javascript:10,log:8,make:7,manag:3,map:7,nginx:8,oscar:10,overrid:7,overview:7,paramet:11,pars:7,pass:7,plugin:9,point:9,post:9,pre:9,prime:6,privaci:[6,14],privat:14,project:12,protect:[1,14],proxi:2,python3:5,quickstart:10,refer:8,request:[1,7],requir:12,respons:0,result:[2,7,9],rout:1,run:[5,10],sampl:[0,1],search:[0,9,11,15],searx:[3,5,8,13,14],see:14,server:8,set:7,setup:[2,10],sourc:10,style:10,subdirectori:8,support:5,syntax:15,test:10,theme:10,through:1,tip:10,tool:[],torrent:7,transifex:12,translat:[6,12],updat:[8,12],url:8,use:14,user:13,using:[5,14],uwsgi:8,video:7,web:8,welcom:13,what:14,why:14,yml:7,you:5,your:[3,10]}}) \ No newline at end of file +Search.setIndex({docnames:["admin/api","admin/filtron","admin/morty","blog/admin","blog/blog","blog/python3","dev/contribution_guide","dev/engine_overview","dev/install/installation","dev/plugins","dev/quickstart","dev/search_api","dev/translation","index","user/own-instance","user/search_syntax"],envversion:52,filenames:["admin/api.rst","admin/filtron.rst","admin/morty.rst","blog/admin.rst","blog/blog.rst","blog/python3.rst","dev/contribution_guide.rst","dev/engine_overview.rst","dev/install/installation.rst","dev/plugins.rst","dev/quickstart.rst","dev/search_api.rst","dev/translation.rst","index.rst","user/own-instance.rst","user/search_syntax.rst"],objects:{},objnames:{},objtypes:{},terms:{"boolean":7,"break":6,"byte":7,"case":[8,10,14],"default":[1,2,5,6,8,9,11,13,14,15],"function":[7,9],"import":8,"int":7,"long":14,"new":[3,6,9,10,11,12],"null":8,"public":13,"return":[9,14],"short":10,"static":9,"switch":6,"true":[0,1,7,8,9,10,11],"try":[10,14],But:[3,5,7,14],For:[1,6,8,10,11],IPs:1,Its:[],One:3,The:[0,6,7,8,11,14],Then:[5,10,12],There:6,These:7,Use:1,a2enmod:8,abbrev:15,abl:[6,7],about:[6,8,13],abov:[6,8,11],abus:[1,14],accept:15,access:[1,3,14],access_log:8,account:12,act:[2,3],action:[0,1],activ:[2,5,8,10,11],adapt:7,add:[2,6,8,9,15],added:9,addit:[7,8],addition:[13,14],address:[2,7,14],admin:4,administr:[3,11,14],adopt:6,ads:14,advantag:3,advertis:14,advis:[1,8],affect:3,after:[5,9,10,12],agent:[1,7],aggreg:[1,13,14],ahrefsbot:1,aim:3,all:[0,2,5,6,7,11],allow:[8,15],along:1,alreadi:6,also:[6,8,14,15],alter:6,alwai:[7,10,14],among:[6,14],ani:[11,13],anonym:[13,14],anoth:[3,7],answer:14,anyon:13,anyth:[5,14],apache2:8,api:[7,12,13],api_kei:7,app:8,appear:10,appli:[6,8],applic:[1,3,8],appropri:6,apt:[8,10],arbitrari:7,arch:0,archiv:1,argument:2,arrai:7,art:11,asciimoo:[8,10,12],aspect:6,assign:7,attach:9,author:6,auto:12,autocomplet:[0,11],avail:[8,10,11,14],avoid:1,back:8,baiduspid:1,ban:14,bar:13,barrier:3,base:[7,11],base_url:[7,8],bash:8,becaus:[3,6,7,10,12,14],befor:[5,9,10,14],behaviour:[6,9],being:[1,3,5,13],below:[1,6,8,10,12],besid:14,best:14,better:[7,8,14],between:7,biggest:3,bin:[5,8,10],bingbot:1,bitbucket:0,block:1,born:6,bot:1,both:[5,6,11,14],botlimit:1,boundingbox:7,branch:6,browser:[4,5,6,14],bug:10,bugreport:6,build:[6,8],build_grunt:10,built:[6,7,10],call:[3,12],callback:9,can:[0,1,2,3,5,6,7,8,9,10,13,14],cannot:14,capabl:[3,6],captcha:14,caption:[],categori:[0,7,11,15],certif:8,chainabl:15,chang:[5,8],chapter:6,charact:6,chdir:8,check:[6,7,10,12],checkout:6,chmod:8,choic:14,choos:[6,7],chown:8,citi:7,clear:14,cli:[10,12],client:1,clone:[8,10],code:[8,10,11,14],codebas:3,com:[3,7,8,10,11,12],combin:8,come:[1,5,6,14],comma:11,command:[1,5,8,10,12],commit:[10,12],common:[10,14],compani:14,compat:5,compil:12,complet:11,compon:9,compromis:14,comput:14,concern:6,conf:8,config:[0,7,8,12],configur:[3,12,14],connect:13,consequ:6,construct:7,consult:10,contain:10,content:14,context:9,contribut:13,control:14,convent:6,cooki:[7,13,14],corner:6,could:7,count:8,countri:7,coupl:8,courgett:11,coverag:10,cpu:8,creat:[5,6,8,10,11,12],cryptic:10,css:9,css_depend:9,csv:[1,11],cthulhu:15,ctx:9,curl:1,current:[6,7,15],custom:[6,15],customiz:[0,3],customlog:8,dai:11,data:[7,14],date:[0,7],datetim:7,daunt:3,dbpedia:11,ddg:15,debian:8,debug:8,decid:3,decim:7,def:[7,9],default_local:0,default_on:9,default_them:0,defin:9,delet:[11,12],demon:8,depen:1,depend:[3,5,7,8,10,11],deploi:8,descript:9,deserv:6,desir:[7,10],deutsch:0,dev:8,develop:[3,5,6],differ:[5,6,7],digit:13,disabl:[9,11],disabled_engin:11,disabled_plugin:11,disrespect:6,dive:14,doai_rewrit:11,dockerfil:8,doe:[3,7,11],domain:8,domin:6,don:[5,13],drop:5,duckduckgo:[11,15],each:11,easi:13,easili:6,edit:[3,6,8,14],effect:6,either:10,elimin:10,emb:13,embed:[0,8],empti:11,en_u:7,enabl:[0,6,8,10,11],enabled_engin:11,enabled_plugin:11,encrypt:13,engin:[0,3,6,10,11,13,14,15],english:0,enough:12,enpoint:11,enter:[5,8],error:10,error_log:8,esperanto:0,essenti:8,etc:[1,6,8],everi:[7,14],everyon:14,everyth:[8,14],exactli:1,exampl:[0,1,8,10,11,14],exceed:1,except:[5,6],exchang:14,execut:12,exist:[3,6],exit:8,expect:6,experienc:3,explain:6,extend:[6,9],extens:6,extern:[1,2,7,11,14],extrem:3,fail:10,fals:[0,8,9,10,11],fanci:6,featur:[2,3,6,14],feedback:6,feedfetch:1,feel:9,few:[6,7],file:[3,5,6,8,9,10,12],file_filt:12,filenam:7,files:7,filter:[0,1,11],find:1,fine:8,finish:12,firewal:1,first:[3,5,10,14],fit:9,fix:[6,10],flask:9,folder:[6,7,10,12],follow:[1,2,6,7,10,12],followsymlink:8,fork:6,form:[0,14],format:[1,7,10,11],forward:[1,8,14],found:[1,3],foundat:[3,5],free:[8,9,13],friend:14,friendli:[],from:[1,4,5,6,12,13,14],fulli:3,further:10,furthermor:[7,10,11,14],gain:14,gener:[0,6,14],geojson:7,german:0,get:[6,7,8,10,11,12,13],gid:8,git:[8,10],github:[3,5,8,10,11],give:10,goi:0,going:[1,14],good:[6,10],googl:[0,11],googlebot:1,grant:8,graphic:3,group:14,grow:3,grunt:10,gui:[],guid:[3,10],hack:[3,5,6],hackerspac:15,handl:14,handler:8,happi:[3,5,6],hard:3,has:[2,6,7,10,14],have:[3,5,6,7,8,14],header:[1,7],help:[6,10],her:[11,14],hex:8,hidden:[0,14],his:[11,14],home:12,host:[1,3,12,13],hotkei:0,hour:8,hous:7,house_numb:7,how:13,howev:[7,11],html:[0,6,7],http:[0,1,2,3,7,8,10,12,13],http_host:1,https_rewrit:11,hub:8,idea:10,imag:[0,2,11,15],image_proxi:11,img_src:7,implement:[3,5,6,7,9],includ:8,inclus:15,index:8,infinite_scrol:11,inform:[1,2,6,7,8],ini:8,init:8,initi:12,input:0,insert:12,insid:7,insight:14,instal:[1,2,5,6,10,12,13],instanc:[0,4,8,11,12,13],instance_nam:0,instead:[3,5,10],integr:13,intent:6,interfac:4,interfer:6,intern:10,internet:13,interpret:8,interpretor:8,interv:1,introduc:[3,4],introduct:10,investig:5,iso:7,issu:5,its:[3,6,11,14],itself:6,jame:1,js_depend:9,json:[1,11],just:[0,14],kei:[2,7,12],kind:14,know:14,kvch:[3,5],lack:6,lang:[0,11,12],languag:[0,7,11,12,15],language_support:7,laptop:14,lat:7,latest:12,latitud:7,lazi:8,lc_messag:12,least:5,leech:7,leecher:7,legaci:11,length:6,less:[3,10,14],let:14,level:6,libapache2:8,libffi:8,libssl:8,libxslt:8,light:8,like:[0,7,8],like_hotkei:11,limit:1,line:6,linkdexbot:1,linux:0,list:[7,9,11,15],listen:[1,8],local:[0,5,7,8,9,10,12],localhost:8,locat:[1,8],log:[10,14],logicodev:11,lon:7,longitud:7,low:8,magnetlink:7,main:12,make:[3,5,8,14],manag:[4,8,10],mani:1,manipul:3,map:0,mass:6,master:8,matter:[7,14],max:[1,7],maxim:6,maximum:[6,7],mean:14,media:[0,7],mention:5,messag:[1,10,12],messagespo:12,metasearch:[7,13],method:[0,7],might:[6,11,14],migrat:5,min:7,misbehav:6,mj12bot:1,mod:8,modifi:15,modul:8,monet:14,month:[0,11],more:[2,3,6,8,11,13,14],morti:2,most:[5,14],msnbot:1,multibl:7,multipl:14,must:[5,6,7,10],myproject:10,name:[0,1,7,8,9,12],necessari:8,need:[6,14],neither:13,net:13,netvib:1,newcom:3,nginx:1,nlnet:[3,5],node:10,nodej:10,none:[7,11],nor:13,normal:7,note:[6,8,11],now:[5,9],npm:10,number:[1,7,8,11],number_of_result:7,object:[7,9],off:[6,8],often:7,okhin:8,on_result:9,one:[13,14],ones:7,onli:[2,8,9,11],onlin:13,open:[5,11,14],openssl:8,openstreetmap:0,oper:[5,14],option:[2,3,7,8,9,10,11,14],order:[6,10],org:7,org_bot:1,organis:13,origin:8,oscar:[0,11],osm:[0,7],other:[6,7,14],otherwis:7,our:3,out:6,output:11,over:13,overview:13,overwritten:7,own:[13,14],packag:[8,10],page:[1,3,6,7,11,14,15],pageno:[7,11],pagenumb:7,param:[1,7],paramet:7,paramt:7,pars:11,part:3,parti:14,partli:7,pass:11,past:0,patch:6,path:[1,8],peopl:[3,14],pep8:[6,10],per:7,perform:7,phase:10,pip3:5,pip:[6,12],pix:11,place:[6,7,14],pleas:[5,6,8,10,11],plenti:6,plugin:[0,6,8,11,13],point:[8,14],pointhi:11,port:[1,8],possibl:[2,8,11],post:[0,6,8,11],post_search:9,postcod:7,pot:12,pre_search:9,prefer:[3,11,14,15],prefix:15,preserv:6,preview:7,privaci:8,privat:13,problem:1,proce:8,process:1,profil:[13,14],project:1,promot:13,proper:14,properli:5,protect:[6,13],provid:[6,7],proxi:[8,11,13,14],proxifi:2,proxy_add_x_forwarded_for:[1,8],proxy_buff:8,proxy_pass:[1,8],proxy_set_head:[1,8],publish:7,publishedd:7,pull:[6,8,12],purpos:7,pybabel:[8,12],python2:5,python3:4,python:[1,5,8],pythonpath:8,quadratur:13,queri:[0,7,11,14,15],question:14,quickstart:[6,13],quit:6,qwer:15,rand:8,random:[7,14],rang:[7,11],rate:1,readm:2,real:1,reason:3,recommend:7,reconsid:6,redefin:7,reduc:6,refer:[13,14],regardless:14,rememb:6,remote_addr:1,remov:14,renam:11,replac:[3,9],repo:6,repositori:[3,8],request:[6,9,14],requir:[5,6,7,10,11],reset:14,respect:[6,14],restart:[2,8],result:[11,13,14],result_proxi:2,results_on_new_tab:11,retriev:12,revers:8,rewrit:[0,8],right:[8,9,13],road:7,roboag:1,robotframework:5,root:8,round:6,rss:[1,11],rst:6,rule:1,run:[1,2,8,9,12,14],safe:11,safe_search:0,safesearch:11,same:[1,7],satisfi:10,scheme:[1,8],scrapi:1,script:[1,8,10],script_nam:8,search:[1,6,7,13,14],search_on_category_select:11,search_path:7,search_str:7,searx:[0,1,2,4,6,7,9,10,11,12,15],sec:1,secur:13,sed:8,see:[2,6,8,11,13,15],seed:7,seeder:7,select:[14,15],selenium:10,self:[3,13],self_inform:11,send:[1,14],sent:14,separ:[6,11],serv:14,server:10,server_nam:8,servic:[1,2,8,11,13,14],set:[2,3,8,10,12,13,14],sethandl:8,setup:[8,13],seznambot:1,she:14,shortcut:[0,7],should:[3,5,6,8,12],simpl:11,simpli:[6,11],sinc:3,singl:[8,14],site:[0,7,8,11],size:7,skip:10,slurp:1,small:7,smtbot:1,snippet:2,social:0,socket:8,sold:14,solv:1,some:8,someon:14,someth:6,sometim:3,sourc:[5,12,14],source_fil:12,source_lang:12,special:7,specif:[7,8],specifi:[7,11],sphinx:6,splinter:5,sponsor:[3,5],ssl:[7,8,13],stack:10,standalon:3,standard:[6,7],start:[1,6,7,8,13],startpag:11,stash:8,step:[6,8],stop:1,store:[7,14],street:7,string:[7,11,12],style:11,submit:6,subrul:1,sudo:[8,10],suggest:9,supervisor:3,support:[4,6,7,11,13,14],sure:[5,8],syntax:[11,13],system:[5,6],tab:11,tailor:14,take:[3,6],tell:7,templat:7,test:[5,6,8],text:[0,7],than:13,thei:14,theme:11,thi:[1,2,3,5,7,8,9,10,11,14],think:6,third:14,those:[12,14],thread:8,three:[6,9,14],through:[11,14],thu:[5,11,14],thumbnail:7,thumbnail_src:7,time:[1,5,7,11,14],time_rang:[0,11],time_range_support:7,timeout:7,titl:7,tld:8,too:[1,14],tool:[3,6,12],tor:[13,14],torrentfil:7,trace:10,track:[13,14],tracker_url_remov:11,traffic:8,transifex:6,transifexrc:12,translat:13,travi:[5,10],trust:[13,14],try_fil:8,tupl:9,turn:[6,10],twice:8,two:[6,11],txt:[5,6],type:[0,7,11,12,14],ubuntu:8,ugli:3,uid:8,ultrasecretkei:8,uncommon:6,under:[6,7],understand:3,unfortun:6,unit:[6,10],unit_test:10,univers:8,unix:8,unknown:14,unlik:14,unspecifi:7,updat:6,update_dev_packag:10,update_packag:8,uri:8,url:[0,2,7,14],urlencod:7,usag:3,use:[2,6,7,8,13],used:[5,6,7,8,13,14],user:[1,6,7,8,14],useradd:8,userag:1,uses:[7,14],using:[1,6,8,10,12,13],usr:8,usual:[5,8,14],uwsgi_modifier1:8,uwsgi_param:8,uwsgi_pass:8,uwsgisocket:8,valid:[7,10,11],valu:[0,7],variabl:7,variou:[6,9],vendor:6,venv3:5,verifi:7,version:5,via:[3,15],view:14,vim:[0,11],virtual:8,virtualenv:[5,8,10],visit:14,vpn:14,vulner:14,wai:[6,7,14],want:[5,11,14],warn:8,web:3,webapp:[5,8],webcrawl:1,websit:0,weird:6,were:5,wget:1,whatev:8,when:[5,9,10,14],where:1,whether:[10,14],which:[1,3,6,7,11,13,14],who:[3,8,14],whole:[8,9],why:13,wide:6,wiki:0,wikipedia:[11,15],wish:6,without:[7,13,14],won:5,wonderfal:8,word:[9,11],work:[6,7,8,10,14],worker:8,world:[6,14],worri:5,worth:14,wsgi:8,www:12,yacybot:1,yahoo:1,yandexbot:1,yandexmobilebot:1,year:11,yet:7,yml:[2,3,8,10],you:[6,8,10,11,13,14,15],your:[2,4,5,6,8,9,13],your_morty_proxy_kei:2,yourself:6,zgrab:1,zlib1g:8},titles:["Administration API","How to protect an instance","How to setup result proxy","Searx admin interface: manage your instance from your browser","Blog","Introducing Python3 support","How to contribute","Engine overview","Installation","Plugins","Development Quickstart","Search API","Translation","Welcome to searx","Why use a private instance?","Search syntax"],titleterms:{"default":7,"new":[],"public":14,"return":7,about:14,acknowledg:[3,5],admin:3,administr:[0,13],apach:8,api:[0,11],argument:7,autocomplet:[],bar:0,basic:8,blog:4,browser:3,bug:5,build:10,categori:[],check:8,code:[6,7],compil:10,conclus:14,configur:[0,1,7,8],consequ:14,content:[7,8],contribut:6,data:0,debug:10,design:6,develop:[10,13],direct:6,disabl:8,disabled_engin:[],disabled_plugin:[],docker:8,document:[6,13],doe:14,emb:0,enabled_engin:[],enabled_plugin:[],engin:7,entri:9,environ:10,exampl:[7,9,15],fact:5,featur:13,file:7,filtron:1,format:[],found:5,from:[3,8],fun:5,gener:7,get:0,hackabl:6,hook:9,host:8,how:[1,2,5,6,8,10,14],imag:7,image_proxi:[],init:12,instal:[3,8],instanc:[1,3,14],interfac:3,introduc:5,javascript:10,lang:[],log:8,make:7,manag:3,map:7,nginx:8,oscar:10,overrid:7,overview:7,pageno:[],paramet:11,pars:7,pass:7,plugin:9,point:9,post:9,pre:9,prime:6,privaci:[6,14],privat:14,project:12,protect:[1,14],proxi:2,python3:5,queri:[],quickstart:10,refer:8,request:[1,7],requir:12,respons:0,result:[2,7,9],results_on_new_tab:[],rout:1,run:[5,10],safesearch:[],sampl:[0,1],search:[0,9,11,15],searx:[3,5,8,13,14],see:14,server:8,set:7,setup:[2,10],sourc:10,style:10,subdirectori:8,support:5,syntax:15,test:10,theme:10,through:1,time_rang:[],tip:10,tool:[],torrent:7,transifex:12,translat:[6,12],updat:[8,12],url:8,use:14,user:13,using:[5,14],uwsgi:8,video:7,web:8,welcom:13,what:14,why:14,yml:7,you:5,your:[3,10]}}) \ No newline at end of file