Skip to content

Commit

Permalink
Radme and default configs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
karust committed Jun 25, 2023
1 parent 46758db commit 6c4eb8d
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 10 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,6 @@ raw.go
dev.md
.gitignore
logrus.txt
logs.txt
logs.txt
.release
core/test/
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,27 @@

[![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:
```bash
# 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.
Expand Down
2 changes: 1 addition & 1 deletion config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ app:
verbose: true
timeout: 15
head: false
leakless: true
leakless: false
5 changes: 3 additions & 2 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 6c4eb8d

Please sign in to comment.