Skip to content

Commit

Permalink
Add note on HTTPS requirement
Browse files Browse the repository at this point in the history
  • Loading branch information
coatless committed Jan 12, 2024
1 parent 0975d46 commit 205ea5b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,26 @@ Otherwise, you can specify it each time:
webr::install("pkgname", "https://gh-username.github.io/repo-name")
```

<div>

> **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
</div>

## Verify

Go to the [webR REPL Editor](https://webr.r-wasm.org/v0.2.2/) (pinned to
Expand Down
15 changes: 15 additions & 0 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 205ea5b

Please sign in to comment.