update readmes

This commit is contained in:
Wonderfall
2016-05-12 00:16:33 +02:00
parent 1679a9ba5d
commit 6d54f4b762
14 changed files with 174 additions and 270 deletions

View File

@ -6,25 +6,14 @@
Searx is a metasearch engine, inspired by the seeks project.
It provides basic privacy by mixing your queries with searches on other platforms without storing search data. Queries are made using a POST request on every browser (except chrome*). Therefore they show up in neither our logs, nor your url history. In case of Chrome* users there is an exception, Searx uses the search bar to perform GET requests. Searx can be added to your browser's search bar; moreover, it can be set as the default search engine.
#### Tags
- `latest` : latest code from [asciimoo/searx](https://github.com/asciimoo/searx)
- `release`, `0.8.1` : latest stable released
#### Secret key
When the container starts the first time, it generates a new secret key. It doesn't depend on the build, so no one can know your key.
#### Features
- Based on Alpine Linux.
- Latest code from [asciimoo/searx](https://github.com/asciimoo/searx)
- A unique secret key is generated when booting the first time.
#### Environment variables
- **IMAGE_PROXY** is a boolean value (True or False, False by default), it can enable proxying through the searx instance (useful for public instances because it doesn't break TLS connection).
- **BASE_URL** should be set if searx is used behind a custom domain name (http address or False, False by default).
- **IMAGE_PROXY** : enables images proxying *(default : False)*
- **BASE_URL** : http://domain.tld *(default : False)*
#### Docker Compose (example)
```
searx:
image: wonderfall/searx:latest
environment:
- BASE_URL="https://searx.domain.tld"
- IMAGE_PROXY=True
```
#### Reverse proxy
https://github.com/Wonderfall/dockerfiles/tree/master/reverse
#### Ports
- **80** [(reverse proxy!)](https://github.com/hardware/mailserver/wiki/Reverse-proxy-configuration)