Skip to content

docs: clarify OpenViking local setup - #37332

Open
NPFernando wants to merge 1 commit into
NousResearch:mainfrom
NPFernando:naveen/openviking-local-setup-docs
Open

docs: clarify OpenViking local setup#37332
NPFernando wants to merge 1 commit into
NousResearch:mainfrom
NPFernando:naveen/openviking-local-setup-docs

Conversation

@NPFernando

Copy link
Copy Markdown
Contributor

Summary

  • Clarify OpenViking provider setup docs for profile-local .env configuration
  • Document supported tenant env vars: OPENVIKING_ACCOUNT, OPENVIKING_USER, and OPENVIKING_AGENT
  • Add local Ollama nomic-embed-text embedding setup guidance and validation commands
  • Note embedding-only behavior where session/resource storage may be visible before extracted long-term memories

Validation

  • Markdown/env sanity checks passed
  • PYTHONPATH=. /home/npfernando/.hermes/hermes-agent/venv/bin/python -m pytest tests/plugins/memory/test_openviking_provider.py tests/openviking_plugin/test_openviking.py -q -o 'addopts=' → 30 passed
  • npx docusaurus build --locale en → passed

Notes

  • npm run typecheck currently fails on an unrelated existing issue in src/components/UserStoriesCollage/index.tsx (Cannot find namespace 'JSX').
  • English Docusaurus build reports an unrelated existing broken link from /docs/user-guide/features/web-dashboard to /docs/integrations/mcp.

@alt-glitch alt-glitch added type/docs Documentation improvements comp/plugins Plugin system and bundled plugins tool/memory Memory tool and memory providers P3 Low — cosmetic, nice to have labels Jun 2, 2026
@teknium1

Copy link
Copy Markdown
Contributor

Thanks for the detailed local-setup documentation. The profile-local and tenant-configuration direction is useful, but this patch needs alignment with the current provider behavior and the related successor work.

Problems

  • plugins/memory/openviking/__init__.py:878-897 supports both linked ovcli.conf and environment overrides, so the proposed “all ... active profile .env” framing is incomplete. The existing README already describes the linked-ovcli.conf path at plugins/memory/openviking/README.md:17-19.
  • API-key requests omit tenant headers by default in _VikingClient._headers() (plugins/memory/openviking/__init__.py:234-259); the proposed API-key tenant wording conflicts with that behavior and with README.md:39-41.
  • Related open PR fix(openviking): harden session sync and commit recovery #58871 explicitly folds this work in via cherry-pick 301bea8c543d0df697adf73d794d9eb69455027f and updates the setup model to openviking-server init / doctor plus ov.conf / ovcli.conf boundaries.

Suggested changes

Automated hermes-sweeper review.

@teknium1 teknium1 added the sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users label Jul 13, 2026

@GottZ GottZ left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was generated by AI during triage.

Summary

Two PRs address the OpenViking documentation gap, but neither has a recorded Verify verdict. #37332 adds profile-local configuration, Ollama embedding, and validation guidance, while #58870 updates the same setup surface to the current openviking-server init/doctor flow and separates ov.conf, ovcli.conf, and Hermes profile configuration.

Related pull requests

  • #37332 related — (+129/-8) — keep open with a salvage path: the diff contains useful Ollama nomic-embed-text, embedding-only behavior, profile isolation, and validation guidance, but its all-.env framing and API-key tenant claims conflict with the provider behavior cited at plugins/memory/openviking/__init__.py:878-897 and plugins/memory/openviking/__init__.py:234-259. This follows the maintainer-bot keep_open review: salvage those additions while documenting both connection paths and the actual trusted/API-key header semantics using #58871's current setup boundary.
  • #58870 [closed] duplicate — (+60/-11) — superseded reference implementation: its diff directly corrects the outdated setup model with openviking-server init/doctor and explicit ov.conf/ovcli.conf/profile-.env boundaries. Although closed, it remains relevant because contributor review records that #58871 incorporates this documentation refresh, avoiding a separate docs-only change.

Duplicates

#37332 and #58870 partially duplicate the profile-local OpenViking setup documentation; #58870's current configuration model was subsequently folded into #58871, while #37332 retains distinct Ollama and embedding-only guidance.

Suggested consolidation

Keep #37332 open with a salvage path, consistent with the maintainer-bot verdict: retain its Ollama embedding example, embedding-only storage/extraction caveat, profile-isolation example, and validation commands, but rework them onto #58871's openviking-server init/doctor and ov.conf/ovcli.conf boundaries and correct the tenant-header semantics. #58870 is already closed and superseded by #58871; treat its overlapping setup changes as the reference for consolidating that portion rather than reopening it.

Complex graph

flowchart LR
    classDef open fill:#dbeafe,stroke:#1d4ed8,color:#1e3a8a
    classDef merged fill:#dcfce7,stroke:#15803d,color:#14532d
    classDef closed fill:#e5e7eb,stroke:#6b7280,color:#1f2937
    classDef unverified fill:#f3f4f6,stroke:#9ca3af,color:#374151
    classDef best stroke-width:3px,stroke:#b45309
    classDef target stroke-width:3px,stroke:#4338ca
    subgraph Dup37332 ["PRs duplicating each other"]
        P37332["PR #37332 (open)"]
        P58870["PR #58870 (closed)"]
    end
    class P37332 open
    class P58870 closed
    class P37332 target
    click P37332 "https://github.com/NousResearch/hermes-agent/pull/37332"
    click P58870 "https://github.com/NousResearch/hermes-agent/pull/58870"
Loading

Graph: solid arrow = fixes / best fix, dashed arrow = partial or unverified (see edge label); boxed group = PRs duplicating each other; amber border = best fix; indigo border = target; gray node = closed (state tag in the node label).

Cross-PR triage: Reviewed 2 pull requests and 0 issues in this complex. Each diff was read against this issue; Assessment working set: 11 kB of PR diffs, 2 kB of issue/PR text, <1 kB of discussion (2 comments), 0 verify verdicts. verdicts reflect diff content, not PR titles. Part of an automated triage batch.

@ehz0ah

ehz0ah commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Thanks for the contribution. This PR should close because current main already documents profile-specific setup and the correct separation between Hermes settings, ovcli.conf, and ov.conf. OpenViking now owns local model setup through openviking-server init and doctor. Any detailed Ollama guide should be maintained in OpenViking to prevent the Hermes documentation from becoming outdated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp/plugins Plugin system and bundled plugins P3 Low — cosmetic, nice to have sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users tool/memory Memory tool and memory providers type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants