Radme and default configs fix

This commit is contained in:
Rustem Kamalov
2023-06-25 20:39:14 +03:00
parent 46758db428
commit 6c4eb8db1a
4 changed files with 12 additions and 10 deletions

4
.gitignore vendored
View File

@@ -21,4 +21,6 @@ raw.go
dev.md
.gitignore
logrus.txt
logs.txt
logs.txt
.release
core/test/

View File

@@ -3,14 +3,13 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/karust/openserp)](https://goreportcard.com/report/github.com/karust/openserp)
[![Go Reference](https://pkg.go.dev/badge/github.com/karust/openserp.svg)](https://pkg.go.dev/github.com/karust/openserp)
<!-- ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/karust/openserp/latest)
![GitHub release (by tag)](https://img.shields.io/github/downloads/karust/openserp/0.1/total) -->
[![release](https://img.shields.io/github/release-pre/karust/openserp.svg)](https://github.com/derailed/k9s/releases)
<!-- ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/karust/openserp/latest) -->
API access for search engines results if available isn't free.
Using OpenSERP, you can get search results from **Google**, **Yandex**, **Baidu** via API or CLI!
See [Docker](#docker), [CLI](#cli) usage examples below.
See [Docker](#docker) and [CLI](#cli) usage examples below.
## Docker usage <a name="docker"></a> 🐳
* Run API server:
@@ -18,13 +17,13 @@ See [Docker](#docker), [CLI](#cli) usage examples below.
# Use prebuilt image
docker run -p 127.0.0.1:7000:7000 -it karust/openserp serve -a 0.0.0.0 -p 7000
# Or
# Or build one and run using docker-compose.yaml
docker-compose up --build
```
### *Example request*
Get 20 **Google** results for `hello world`, only in English:
```JSON
```
GET http:/127.0.0.1:7000/google/search?lang=EN&limit=20&text=hello world
```
You can replace `google` to `yandex` or `baidu` in query to change search engine.

View File

@@ -5,4 +5,4 @@ app:
verbose: true
timeout: 15
head: false
leakless: true
leakless: false

View File

@@ -3,7 +3,8 @@ version: '3'
services:
openserp:
container_name: serp
image: openserp
build:
context: .
ports:
- 7000:7000
command: serve -a 0.0.0.0 -p 7000
command: serve -a 0.0.0.0 -p 7000 -v -l