From 205ea5b7565962baa6194fab62b44f0b62122e23 Mon Sep 17 00:00:00 2001 From: James J Balamuta Date: Thu, 11 Jan 2024 19:52:40 -0800 Subject: [PATCH] Add note on HTTPS requirement --- README.md | 20 ++++++++++++++++++++ README.qmd | 15 +++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/README.md b/README.md index 766872c..9b45c1f 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,26 @@ Otherwise, you can specify it each time: webr::install("pkgname", "https://gh-username.github.io/repo-name") ``` +
+ +> **Important** +> +> Please make sure the repository’s [GitHub Pages website is available +> over +> `HTTPS`](https://docs.github.com/en/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https#enforcing-https-for-your-github-pages-site) +> not `HTTP` (notice the lack of an `s`). You can verify this option was +> selected by: +> +> 1. Going to the repository’s **Settings** page +> 2. Selecting **Pages** under **Code and automation** +> 3. Checking the **Enforce HTTPS** button. +> +> Otherwise, you will receive the error message of: +> +> Warning: unable to access index for repository http://gh-username.github.io/repo-name/bin/emscripten/contrib/4.3 + +
+ ## Verify Go to the [webR REPL Editor](https://webr.r-wasm.org/v0.2.2/) (pinned to diff --git a/README.qmd b/README.qmd index 4a436a4..b7c59b5 100644 --- a/README.qmd +++ b/README.qmd @@ -84,6 +84,21 @@ Otherwise, you can specify it each time: webr::install("pkgname", "https://gh-username.github.io/repo-name") ``` +:::{.callout-important} +Please make sure the repository's [GitHub Pages website is available over `HTTPS`](https://docs.github.com/en/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https#enforcing-https-for-your-github-pages-site) not `HTTP` (notice the lack of an `s`). +You can verify this option was selected by: + +1. Going to the repository's **Settings** page +2. Selecting **Pages** under **Code and automation** +3. Checking the **Enforce HTTPS** button. + +Otherwise, you will receive the error message of: + +``` +Warning: unable to access index for repository http://gh-username.github.io/repo-name/bin/emscripten/contrib/4.3 +``` +::: + ## Verify Go to the [webR REPL Editor](https://webr.r-wasm.org/v0.2.2/) (pinned to v0.2.2)