git.iko.soy/searx
on master help sign in
production environment with supervisor and crontab
commit8210fe90eaff71d5c78cec07e0172444e8b3de97 authorMatej Cotman <cotman.matej@gmail.com> dateWed 15 Jan 2014, 21:18 (13 years ago) parent77bd3e0
5 files changed+71−6
compare with master
unifiedsplit
.gitignore+1 Makefile+7−3 README.md+27−3 minimal.cfg+17 production.cfg+19
.gitignore+1
@@ -15,3 +15,4 @@ eggs/
1515local/
1616searx.egg-info/
1717parts/
18+var/
Makefile+7−3
@@ -37,14 +37,18 @@ coverage: .installed.cfg
3737 @bin/coverage report --show-missing
3838 @bin/coverage html --directory ./coverage
3939
40−minimal: bin/buildout production.cfg setup.py enginescfg
40+production: bin/buildout production.cfg setup.py enginescfg
4141 bin/buildout -c production.cfg $(options)
4242 @echo "* Please modify `readlink --canonicalize-missing ./searx/settings.py`"
4343 @echo "* Hint 1: on production, disable debug mode and change secret_key"
44− @echo "* Hint 2: to run server execute 'bin/searx-run'"
44+ @echo "* Hint 2: searx will be executed at server startup by crontab"
45+ @echo "* Hint 3: to run immediatley, execute 'bin/supervisord'"
46+
47+minimal: bin/buildout minimal.cfg setup.py enginescfg
48+ bin/buildout -c minimal.cfg $(options)
4549
4650clean:
4751 @rm -rf .installed.cfg .mr.developer.cfg bin parts develop-eggs \
4852 searx.egg-info lib include .coverage coverage
4953
50−.PHONY: all tests enginescfg robot flake8 coverage minimal clean
54+.PHONY: all tests enginescfg robot flake8 coverage production minimal clean
README.md+27−3
@@ -7,6 +7,7 @@ List of [running instances](https://github.com/asciimoo/searx/wiki/Searx-instanc
77
88[![Flattr searx](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software)
99
10+
1011### Features
1112
1213* Tracking free
@@ -19,6 +20,7 @@ List of [running instances](https://github.com/asciimoo/searx/wiki/Searx-instanc
1920* Opensearch support (you can set as default search engine)
2021* Configurable search engines/categories
2122
23+
2224### Installation
2325
2426* clone source: `git clone git@github.com:asciimoo/searx.git && cd searx`
@@ -29,6 +31,7 @@ List of [running instances](https://github.com/asciimoo/searx/wiki/Searx-instanc
2931
3032For all the details, follow this [step by step installation](https://github.com/asciimoo/searx/wiki/Installation)
3133
34+
3235### Alternative (Recommended) Installation
3336
3437* clone source: `git clone git@github.com:asciimoo/searx.git && cd searx`
@@ -38,9 +41,26 @@ For all the details, follow this [step by step installation](https://github.com/
3841
3942### Development
4043
41−Just run `make`. Versions of dependencies are pinned down inside `versions.cfg` to produce most stable build.
44+Just run `make`. Versions of dependencies are pinned down inside `versions.cfg` to produce most stable build. Also remember, NO make command should be run as root, not even `make production`
45+
46+
47+### Deployment
48+
49+* clone source: `git clone git@github.com:asciimoo/searx.git && cd searx`
50+* build in current folder: `make production`
51+* run `bin/supervisord` to start the application
4252
43−#### Command make
53+
54+### Upgrading
55+
56+* inside previously cloned searx directory run: `git stash` to temporarily save any changes you have made
57+* pull source: `git pull origin master`
58+* re-build in current folder: `make production`
59+* run `bin/supervisorctl stop searx` to stop searx, if it does not, then run `fuser -k 8888/tcp`
60+* run `bin/supervisorctl reload` to re-read supervisor config and start searx
61+
62+
63+### Command make
4464
4565##### `make`
4666
@@ -62,9 +82,13 @@ Runs robot (Selenium) tests, you must have `firefox` installed because this func
6282
6383Checks coverage of tests, after running this, execute this: `firefox ./coverage/index.html`
6484
85+##### `make production`
86+
87+Used to make co-called production environment - without tests (you should ran tests before deploying searx on the server). This installs supervisord, so if searx crashes, it will try to pick itself up again. And crontab entry is added to start supervisord at server boot.
88+
6589##### `make minimal`
6690
67−Used to make co-called production environment - without tests (you should ran tests before deploying searx on the server).
91+Minimal build - without test frameworks, the quickest build option.
6892
6993##### `make clean`
7094
minimal.cfgnew file+17
@@ -0,0 +1,17 @@
1+[buildout]
2+extends = base.cfg
3+develop = .
4+
5+eggs =
6+ searx
7+
8+parts +=
9+ pyscripts
10+
11+
12+[pyscripts]
13+recipe = zc.recipe.egg:script
14+eggs = ${buildout:eggs}
15+interpreter = py
16+entry-points =
17+ searx-run=searx.webapp:run
production.cfg+19
@@ -7,6 +7,8 @@ eggs =
77
88parts +=
99 pyscripts
10+ supervisor
11+ crontab_reboot
1012
1113
1214[pyscripts]
@@ -15,3 +17,20 @@ eggs = ${buildout:eggs}
1517interpreter = py
1618entry-points =
1719 searx-run=searx.webapp:run
20+
21+
22+[supervisor]
23+recipe = collective.recipe.supervisor
24+http-socket = unix
25+user = searxer
26+password = ohpleasedochangeme
27+file = /tmp/supervisor.sock
28+chmod = 0700
29+programs =
30+ 50 searx ${buildout:bin-directory}/searx-run
31+
32+
33+[crontab_reboot]
34+recipe = z3c.recipe.usercrontab
35+times = @reboot
36+command = ${buildout:bin-directory}/supervisord