docs: add comprehensive INSTALL.md guide#262
Draft
ZaynJarvis wants to merge 9 commits intovolcengine:mainfrom
Draft
docs: add comprehensive INSTALL.md guide#262ZaynJarvis wants to merge 9 commits intovolcengine:mainfrom
ZaynJarvis wants to merge 9 commits intovolcengine:mainfrom
Conversation
Add installation guide covering: - Python package installation and verification - Rust CLI (ov) installation options - Server configuration (ov.conf) with examples - CLI configuration (ovcli.conf) setup - Step-by-step verification for each component - Example skills overview (adding-memory, adding-resource, searching-context) - Troubleshooting section for common issues This guide helps both humans and agents quickly set up and verify their OpenViking installation.
Major updates to installation guide: - Emphasize ov CLI is REQUIRED (not optional) for fast skill execution - Emphasize server mode is REQUIRED for skills (faster performance) - Add architecture diagram showing multi-client deployment - Add hint that server can run anywhere (cloud, VM, container, local) - Skills moved to Step 3 (core component, not just examples) - Detailed skill descriptions: adding-memory, adding-resource, searching-context - Include trigger keywords (ovm, ovr, ovs) and what each skill does - Add multi-client deployment options table - Reorder: Installation → Skills → Config → Running → Verification → Troubleshooting - Add skill functionality verification section
- Add Step 1: Install uv with instructions for macOS/Linux/Windows - Update expected version numbers: openviking 0.1.18, ov 0.1.0 - Add workspace field to full configuration template - Add OPENVIKING_CONFIG_DIR as alternative config method - Expand skills section with usage guide and chat trigger examples - Show how ovm/ovr/ovs keywords trigger skills during chat
- Remove pip as an alternative - uv is now the one and only way - Emphasize uv automatically manages virtual environments - Update all commands to use uv (uv pip install, uv run python, etc.) - Remove 'recommended' qualifiers - uv is required, not optional
Major restructuring for clarity: INSTALLATION.md (Quick Guide): - Focus only on essential steps to get skills running - Use uv tool install for clean, standalone installation - Include nohup command for background server execution - Simple 6-step process: uv -> server -> ov CLI -> config -> start -> skills - Add skill usage examples with ovm/ovr/ovs keywords - Quick test section for immediate verification - Reference advanced guide for detailed options INSTALLATION_ADVANCED.md (New): - Full configuration reference with all fields - Alternative installation methods (pip, dev, manual venv) - Cloud deployment guides (Volcengine ECS, AWS/GCP/Azure) - Docker and Kubernetes examples - Multiple model provider configs (OpenAI, Anthropic, vLLM) - Authentication, security, HTTPS setup - Systemd service configuration - Performance tuning and troubleshooting
ZaynJarvis
changed the title
- Rename INSTALLATION.md → INSTALL.md - Rename INSTALLATION_ADVANCED.md → INSTALL_ADVANCED.md - Simplify README installation section to point to INSTALL.md - Add 'Building from Source' section to INSTALL_ADVANCED.md with Go/AGFS details - Remove build-from-source details from quick install guide
- Remove unsupported storage.workspace field - Use working storage.vectordb/agfs.backend format - Add note about data directory location
ZaynJarvis
force-pushed
the
docs/installation-guide
branch
from
f1965a3 to
447535c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a comprehensive installation guide at the root of the repository to help both humans and agents quickly set up and verify their OpenViking installation.
What's Included
Installation Instructions
pip install openvikingwith verification stepsConfiguration
ov.conf): Minimal and full configuration templatesovcli.conf): Connection settings for the ov CLIVerification
Example Skills
examples/skills/:adding-memory(ovm trigger)adding-resource(ovr trigger)searching-context(ovs trigger)examples/skills/tests.mdfor test casesTroubleshooting
Common issues and solutions for:
Why This Helps