Navegador

navegador / docs / getting-started / configuration.md
Source Rendered
Blame History Raw 159 lines
1
# Configuration
2
3
Navegador has minimal required configuration. The only thing you typically need to set is where the graph database lives.
4
5
---
6
7
## Database path
8
9
### SQLite (default)
10
11
By default navegador writes a `navegador.db` file in the current working directory. Override with the `--db` flag or the `NAVEGADOR_DB` environment variable:
12
13
```bash
14
# flag (takes precedence)
15
navegador ingest ./repo --db ~/.navegador/myproject.db
16
17
# environment variable
18
export NAVEGADOR_DB=~/.navegador/myproject.db
19
navegador ingest ./repo
20
```
21
22
The `.navegador/` directory convention keeps the database alongside your project:
23
24
```
25
my-project/
26
.navegador/
27
navegador.db ← graph database
28
src/
29
...
30
```
31
32
Add `.navegador/` to `.gitignore` — the database is a build artifact, not source.
33
34
### Redis (production)
35
36
For team or CI environments, point `NAVEGADOR_DB` at a Redis instance running FalkorDB:
37
38
```bash
39
export NAVEGADOR_DB=redis://localhost:6379
40
```
41
42
With authentication:
43
44
```bash
45
export NAVEGADOR_DB=redis://:[email protected]:6379
46
```
47
48
Install the Redis extra if you haven't already:
49
50
```bash
51
pip install "navegador[redis]"
52
```
53
54
---
55
56
## SQLite vs Redis: when to use which
57
58
| | SQLite (falkordblite) | Redis (FalkorDB) |
59
|---|---|---|
60
| Setup | Zero config | Requires a Redis server |
61
| Use case | Local dev, single developer | Team, CI, shared context |
62
| Persistence | Local file | Redis persistence config |
63
| Performance | Fast for single-user workloads | Scales to large codebases |
64
| Extra required | None (included) | `navegador[redis]` |
65
66
Both backends implement the same `GraphStore` interface. You can migrate by re-ingesting against the new backend.
67
68
---
69
70
## GitHub token
71
72
Required for `navegador wiki ingest --repo owner/repo` to access private wikis or to avoid rate limits on public repos.
73
74
```bash
75
export GITHUB_TOKEN=ghp_...
76
navegador wiki ingest --repo myorg/myrepo
77
```
78
79
For public repos, wiki ingestion works without a token but will hit GitHub's unauthenticated rate limit (60 req/hr).
80
81
---
82
83
## Project-local config
84
85
Drop a `.navegador/config.toml` in your project root for project-specific defaults:
86
87
```toml
88
[database]
89
path = ".navegador/navegador.db"
90
91
[ingest]
92
exclude = ["node_modules", "dist", ".venv", "migrations"]
93
incremental = true # use content hashing by default
94
redact = false # strip secrets from ingested content
95
96
[mcp]
97
read_only = false # set true to prevent agents from writing to the graph
98
max_query_complexity = 100 # Cypher query complexity limit
99
```
100
101
---
102
103
## LLM provider config
104
105
Configure LLM providers used by `navegador ask`, `navegador docs`, and `navegador semantic-search`. Requires `pip install "navegador[llm]"`.
106
107
```toml
108
[llm]
109
provider = "anthropic" # "anthropic", "openai", or "ollama"
110
model = "claude-3-5-haiku-20241022"
111
112
[llm.anthropic]
113
api_key_env = "ANTHROPIC_API_KEY" # env var name (not the key itself)
114
115
[llm.openai]
116
api_key_env = "OPENAI_API_KEY"
117
model = "gpt-4o-mini"
118
119
[llm.ollama]
120
base_url = "http://localhost:11434"
121
model = "llama3"
122
```
123
124
---
125
126
## Cluster config
127
128
For team deployments using a shared Redis graph with pub/sub, task queue, and session coordination:
129
130
```toml
131
[cluster]
132
enabled = true
133
redis_url = "redis://redis.internal:6379"
134
graph_name = "navegador-team"
135
136
[cluster.pubsub]
137
channel = "navegador:events"
138
139
[cluster.queue]
140
name = "navegador:tasks"
141
142
[cluster.sessions]
143
ttl_seconds = 3600
144
```
145
146
See the [Cluster mode](../guide/cluster.md) guide for full setup instructions.
147
148
---
149
150
## Environment variable reference
151
152
| Variable | Default | Description |
153
|---|---|---|
154
| `NAVEGADOR_DB` | `./navegador.db` | Path to SQLite file or `redis://` URL |
155
| `GITHUB_TOKEN` | — | GitHub personal access token for wiki ingestion |
156
| `ANTHROPIC_API_KEY` | — | Anthropic API key for LLM features |
157
| `OPENAI_API_KEY` | — | OpenAI API key for LLM features |
158
| `NAVEGADOR_CONFIG` | `.navegador/config.toml` | Override config file path |
159

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button