{"id":30240388,"url":"https://github.com/hypothesis/viahtml","last_synced_at":"2025-08-15T04:38:22.794Z","repository":{"id":37403311,"uuid":"291037661","full_name":"hypothesis/viahtml","owner":"hypothesis","description":"HTML proxying component for Via","archived":false,"fork":false,"pushed_at":"2025-08-06T08:54:21.000Z","size":754,"stargazers_count":4,"open_issues_count":19,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-08-06T10:31:58.723Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hypothesis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-08-28T12:12:14.000Z","updated_at":"2025-08-06T08:54:24.000Z","dependencies_parsed_at":"2024-01-09T12:27:52.964Z","dependency_job_id":"e5a077b5-291f-4097-a844-d4af9c63615f","html_url":"https://github.com/hypothesis/viahtml","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/hypothesis/viahtml","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fviahtml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fviahtml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fviahtml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fviahtml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hypothesis","download_url":"https://codeload.github.com/hypothesis/viahtml/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hypothesis%2Fviahtml/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270524412,"owners_count":24600195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-15T04:38:19.789Z","updated_at":"2025-08-15T04:38:22.785Z","avatar_url":"https://github.com/hypothesis.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Via HTML\n========\n\nA proxy that serves up third party HTML pages with the\n[Hypothesis client](https://github.com/hypothesis/client) embedded, so you can\nannotate them.\n\nInstalling Via HTML in a development environment\n------------------------------------------------\n\n### You will need\n\n* Via HTML integrates with h and the Hypothesis client, so you will need to\n  set up development environments for each of those before you can develop Via:\n\n  * https://h.readthedocs.io/en/latest/developing/install/\n  * https://h.readthedocs.io/projects/client/en/latest/developers/developing/\n\n* [Git](https://git-scm.com/)\n\n* [pyenv](https://github.com/pyenv/pyenv)\n  Follow the instructions in the pyenv README to install it.\n  The Homebrew method works best on macOS.\n\n### Clone the git repo\n\n    git clone https://github.com/hypothesis/viahtml.git\n\nThis will download the code into a `viahtml` directory in your current working\ndirectory. You need to be in the `viahtml` directory from the remainder of the\ninstallation process:\n\n    cd viahtml\n\n### Start the development server\n\n    make dev\n\nThe first time you run `make dev` it might take a while to start because it'll\nneed to install the application dependencies and build the assets.\n\nThis will start NGINX running on http://localhost:9085 and reverse proxying to\nUWSGI running the app. If you make changes to the app, you will need to restart\nit.\n\n**That's it!** You’ve finished setting up your Via HTML development environment. \nRun `make help` to see all the commands that are available for running the tests,\nlinting, code formatting, etc.\n\nConfiguration\n-------------\n\nEnvironment variables:\n\n| Name | Effect | Example |\n|------|--------|---------|\n| `CHECKMATE_URL` | The URL of the URL Checkmate instance to use | `https://checkmate.example.com` |\n| `CHECKMATE_API_KEY` | API key to authenticate with Checkmate |\n| `CHECKMATE_ALLOW_ALL` | Whether to bypass Checkmate's allow-list (and use only the blocklist) | `true`\n| `CHECKMATE_IGNORE_REASONS` | Comma-separated list of Checkmate block reasons to ignore | `publisher-blocked,high-io` |\n| `VIA_DEBUG` | Enable debugging logging in dev | `false` |\n| `VIA_H_EMBED_URL` | The URL of the client's embed script | `https://cdn.hypothes.is/hypothesis`\n| `VIA_IGNORE_PREFIXES` | Prefixes not to proxy | `https://hypothes.is/,https://qa.hypothes.is/` |\n| `VIA_ROUTING_HOST` | The host to perform content based routing | `https://via.hypothes.is` |\n| `VIA_DISABLE_AUTHENTICATION` | Disable auth for dev purposes | `false` |\n| `NEW_RELIC_*` | Various New Relic settings. See New Relic's docs for details |\n| `SENTRY_*` | Various Sentry settings. See Sentry's docs for details |\n\nFor details of changing the blocklist see:\n\n * https://stackoverflow.com/c/hypothesis/questions/102/250\n\nArchitecture\n------------\n\nVia HTML is composed of three compoments:\n\n * NGINX running on port 9085\n * UWSGI running a `pywb` based application\n * A docker container running `supervisor` to run the other two parts\n \nThe UWSGI app runs using a binary protocol, which means you can't directly\ncontact it using a browser.\n\nStatic content is served directly from NGINX after being built using \n`make build`. This should happen for you automatically on first run. But if\nyou change the content you may want to re-run it.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypothesis%2Fviahtml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhypothesis%2Fviahtml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhypothesis%2Fviahtml/lists"}