|
@@ -7,31 +7,16 @@ engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__.
|
7
|
7
|
List of `running
|
8
|
8
|
instances <https://github.com/asciimoo/searx/wiki/Searx-instances>`__.
|
9
|
9
|
|
10
|
|
-See the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information.
|
|
10
|
+See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information.
|
11
|
11
|
|
12
|
12
|
|Flattr searx|
|
13
|
13
|
|
14
|
|
-Features
|
15
|
|
-~~~~~~~~
|
16
|
|
-
|
17
|
|
-- Tracking free
|
18
|
|
-- Supports multiple output formats
|
19
|
|
-
|
20
|
|
- - json ``curl https://searx.me/?format=json&q=[query]``
|
21
|
|
- - csv ``curl https://searx.me/?format=csv&q=[query]``
|
22
|
|
- - opensearch/rss ``curl https://searx.me/?format=rss&q=[query]``
|
23
|
|
-- Opensearch support (you can set as default search engine)
|
24
|
|
-- Configurable search engines/categories
|
25
|
|
-- Different search languages
|
26
|
|
-- Duckduckgo like !bang functionality with engine shortcuts
|
27
|
|
-- Parallel queries - relatively fast
|
28
|
|
-
|
29
|
14
|
Installation
|
30
|
15
|
~~~~~~~~~~~~
|
31
|
16
|
|
32
|
17
|
- clone source:
|
33
|
18
|
``git clone git@github.com:asciimoo/searx.git && cd searx``
|
34
|
|
-- install dependencies: ``pip install -r requirements.txt``
|
|
19
|
+- install dependencies: ``./manage.sh update_packages``
|
35
|
20
|
- edit your
|
36
|
21
|
`settings.yml <https://github.com/asciimoo/searx/blob/master/settings.yml>`__
|
37
|
22
|
(set your ``secret_key``!)
|
|
@@ -40,104 +25,6 @@ Installation
|
40
|
25
|
For all the details, follow this `step by step
|
41
|
26
|
installation <https://github.com/asciimoo/searx/wiki/Installation>`__
|
42
|
27
|
|
43
|
|
-Alternative (Recommended) Installation
|
44
|
|
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
45
|
|
-
|
46
|
|
-- clone source:
|
47
|
|
- ``git clone git@github.com:asciimoo/searx.git && cd searx``
|
48
|
|
-- build in current folder: ``make minimal``
|
49
|
|
-- run ``bin/searx-run`` to start the application
|
50
|
|
-
|
51
|
|
-Development
|
52
|
|
-~~~~~~~~~~~
|
53
|
|
-
|
54
|
|
-Just run ``make``. Versions of dependencies are pinned down inside
|
55
|
|
-``versions.cfg`` to produce most stable build. Also remember, NO make
|
56
|
|
-command should be run as root, not even ``make production``
|
57
|
|
-
|
58
|
|
-Deployment
|
59
|
|
-~~~~~~~~~~
|
60
|
|
-
|
61
|
|
-- clone source:
|
62
|
|
- ``git clone git@github.com:asciimoo/searx.git && cd searx``
|
63
|
|
-- build in current folder: ``make production``
|
64
|
|
-- run ``bin/supervisord`` to start the application
|
65
|
|
-
|
66
|
|
-Upgrading
|
67
|
|
-~~~~~~~~~
|
68
|
|
-
|
69
|
|
-- inside previously cloned searx directory run: ``git stash`` to
|
70
|
|
- temporarily save any changes you have made
|
71
|
|
-- pull source: ``git pull origin master``
|
72
|
|
-- re-build in current folder: ``make production``
|
73
|
|
-- run ``bin/supervisorctl stop searx`` to stop searx, if it does not,
|
74
|
|
- then run ``fuser -k 8888/tcp``
|
75
|
|
-- run ``bin/supervisorctl reload`` to re-read supervisor config and
|
76
|
|
- start searx
|
77
|
|
-
|
78
|
|
-Command make
|
79
|
|
-~~~~~~~~~~~~
|
80
|
|
-
|
81
|
|
-``make``
|
82
|
|
-''''''''
|
83
|
|
-
|
84
|
|
-Builds development environment with testing support.
|
85
|
|
-
|
86
|
|
-``make tests``
|
87
|
|
-''''''''''''''
|
88
|
|
-
|
89
|
|
-Runs tests. You can write tests
|
90
|
|
-`here <https://github.com/asciimoo/searx/tree/master/searx/tests>`__ and
|
91
|
|
-remember 'untested code is broken code'.
|
92
|
|
-
|
93
|
|
-``make robot``
|
94
|
|
-''''''''''''''
|
95
|
|
-
|
96
|
|
-Runs robot (Selenium) tests, you must have ``firefox`` installed because
|
97
|
|
-this functional tests actually run the browser and perform operations on
|
98
|
|
-it. Also searx is executed with
|
99
|
|
-`settings\_robot <https://github.com/asciimoo/searx/blob/master/searx/settings_robot.yml>`__.
|
100
|
|
-
|
101
|
|
-``make flake8``
|
102
|
|
-'''''''''''''''
|
103
|
|
-
|
104
|
|
-'pep8 is a tool to check your Python code against some of the style
|
105
|
|
-conventions in `PEP 8 <http://www.python.org/dev/peps/pep-0008/>`__.'
|
106
|
|
-
|
107
|
|
-``make coverage``
|
108
|
|
-'''''''''''''''''
|
109
|
|
-
|
110
|
|
-Checks coverage of tests, after running this, execute this:
|
111
|
|
-``firefox ./coverage/index.html``
|
112
|
|
-
|
113
|
|
-``make production``
|
114
|
|
-'''''''''''''''''''
|
115
|
|
-
|
116
|
|
-Used to make co-called production environment - without tests (you
|
117
|
|
-should ran tests before deploying searx on the server). This installs
|
118
|
|
-supervisord, so if searx crashes, it will try to pick itself up again.
|
119
|
|
-And crontab entry is added to start supervisord at server boot.
|
120
|
|
-
|
121
|
|
-``make minimal``
|
122
|
|
-''''''''''''''''
|
123
|
|
-
|
124
|
|
-Minimal build - without test frameworks, the quickest build option.
|
125
|
|
-
|
126
|
|
-``make clean``
|
127
|
|
-''''''''''''''
|
128
|
|
-
|
129
|
|
-Deletes several folders and files (see ``Makefile`` for more), so that
|
130
|
|
-next time you run any other ``make`` command it will rebuild everithing.
|
131
|
|
-
|
132
|
|
-TODO
|
133
|
|
-~~~~
|
134
|
|
-
|
135
|
|
-- Moar engines
|
136
|
|
-- Better ui
|
137
|
|
-- Browser integration
|
138
|
|
-- Documentation
|
139
|
|
-- Tests
|
140
|
|
-
|
141
|
28
|
Bugs
|
142
|
29
|
~~~~
|
143
|
30
|
|