refactor: remove SearXNG references and rename binary to kafka
- Rename cmd/searxng-go to cmd/kafka - Remove all SearXNG references from source comments while keeping "SearXNG-compatible API" in user-facing docs - Update binary paths in README, CLAUDE.md, and Dockerfile - Update log message to "kafka starting" Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
8ea318ad4a
commit
21b77f25bf
18 changed files with 47 additions and 48 deletions
12
README.md
12
README.md
|
|
@ -24,8 +24,8 @@ A privacy-respecting, open metasearch engine written in Go. SearXNG-compatible A
|
|||
```bash
|
||||
git clone https://git.ashisgreat.xyz/penal-colony/gosearch.git
|
||||
cd kafka
|
||||
go build ./cmd/searxng-go
|
||||
./searxng-go -config config.toml
|
||||
go build ./cmd/kafka
|
||||
./kafka -config config.toml
|
||||
```
|
||||
|
||||
### Docker Compose
|
||||
|
|
@ -76,7 +76,7 @@ sudo nixos-rebuild switch --flake .#
|
|||
```bash
|
||||
nix develop
|
||||
go test ./...
|
||||
go run ./cmd/searxng-go -config config.toml
|
||||
go run ./cmd/kafka -config config.toml
|
||||
```
|
||||
|
||||
## Endpoints
|
||||
|
|
@ -138,7 +138,7 @@ Copy `config.example.toml` to `config.toml` and edit. All settings can also be o
|
|||
### Key Sections
|
||||
|
||||
- **`[server]`** — port, timeout, public base URL for OpenSearch
|
||||
- **`[upstream]`** — optional upstream SearXNG proxy for unported engines
|
||||
- **`[upstream]`** — optional upstream metasearch proxy for unported engines
|
||||
- **`[engines]`** — which engines run locally, engine-specific settings
|
||||
- **`[cache]`** — Valkey/Redis address, password, TTL
|
||||
- **`[cors]`** — allowed origins and methods
|
||||
|
|
@ -152,7 +152,7 @@ Copy `config.example.toml` to `config.toml` and edit. All settings can also be o
|
|||
|---|---|
|
||||
| `PORT` | Listen port (default: 8080) |
|
||||
| `BASE_URL` | Public URL for OpenSearch XML |
|
||||
| `UPSTREAM_SEARXNG_URL` | Upstream SearXNG instance URL |
|
||||
| `UPSTREAM_SEARXNG_URL` | Upstream instance URL |
|
||||
| `LOCAL_PORTED_ENGINES` | Comma-separated local engine list |
|
||||
| `HTTP_TIMEOUT` | Upstream request timeout |
|
||||
| `BRAVE_API_KEY` | Brave Search API key |
|
||||
|
|
@ -177,7 +177,7 @@ See `config.example.toml` for the full list including rate limiting and CORS var
|
|||
| Reddit | Reddit JSON API | Discussions |
|
||||
| Bing | Bing RSS | General web |
|
||||
|
||||
Engines not listed in `engines.local_ported` are proxied to an upstream SearXNG instance if `upstream.url` is configured.
|
||||
Engines not listed in `engines.local_ported` are proxied to an upstream metasearch instance if `upstream.url` is configured.
|
||||
|
||||
## Architecture
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue