mirror of
https://github.com/open-jarvis/OpenJarvis.git
synced 2026-07-28 13:26:48 +00:00
krypticmouseandClaude Opus 4.7
cf8d3e2cbe
The documented install command pointed at `https://openjarvis.ai/install.sh`, but that domain is community-operated (not controlled by this project) and its TLS config broke — every new user hit `sslv3 alert handshake failure` (#337, #352). Since we can't fix a domain we don't control, this moves the installer onto infrastructure we DO control: the project's GitHub Pages docs site. Changes: - **`docs/gen_install_script.py`** (new) + **`mkdocs.yml`**: a `gen-files` hook copies `scripts/install/install.sh` verbatim into the built site at `install.sh` on every `mkdocs build`. Single source of truth — the script stays at `scripts/install/install.sh` (still bundled into the wheel as `_install_scripts/`); the published copy can't drift. Verified locally: `mkdocs build` emits `site/install.sh` byte-identical to the source. New canonical URL: `https://open-jarvis.github.io/OpenJarvis/install.sh` — HTTPS always valid (GitHub's cert), fully under project control. - **`README.md`**: canonical command switched to the github.io URL for both the Installation and Quick Start blocks. Also addresses the uv discoverability gap — explicitly states the curl installer downloads uv for you (no prerequisite), and that the Windows **desktop .exe** expects uv to be installed first, with the exact PowerShell command. - **`docs/getting-started/{install,wsl2,macos,linux}.md`**: canonical URL switched to github.io. `install.md` gains an "Install URL" info note explaining the github.io URL is canonical and that the older `openjarvis.ai` URL is community-operated with intermittent TLS issues. - **`scripts/install/install.sh`** + **`jarvis-wrapper.sh`**: usage comment, the WSL re-run hint (added in #399), and the wrapper's re-install message all updated to the github.io URL. Migration note for maintainers: ask whoever operates `openjarvis.ai` to CNAME it to `open-jarvis.github.io`. Once they do, `openjarvis.ai/install.sh` will serve this same GitHub Pages content with a valid GitHub-managed cert, and the nicer brand URL can become canonical again with zero further code changes. Until then, the github.io URL works and is under our control. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
22 lines
819 B
Python
22 lines
819 B
Python
"""Publish the canonical install.sh into the docs site.
|
|
|
|
Serves the installer at ``https://open-jarvis.github.io/OpenJarvis/install.sh``
|
|
so users have an HTTPS-valid, project-controlled install URL that does not
|
|
depend on the externally-hosted ``openjarvis.ai`` domain — whose TLS config
|
|
broke and which the project does not control (issue #337).
|
|
|
|
Single source of truth: the script lives at ``scripts/install/install.sh``
|
|
(also bundled into the wheel as ``_install_scripts/``). This copies it
|
|
verbatim into the built site at ``install.sh`` on every ``mkdocs build``,
|
|
so the published copy can never drift from the canonical one.
|
|
"""
|
|
|
|
from pathlib import Path
|
|
|
|
import mkdocs_gen_files
|
|
|
|
_SRC = Path("scripts/install/install.sh")
|
|
|
|
with mkdocs_gen_files.open("install.sh", "wb") as dst:
|
|
dst.write(_SRC.read_bytes())
|