Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Commit

Permalink
Updates install docs to mention tags (#44)
Browse files Browse the repository at this point in the history
* Updates install docs to metnion tags

* Update README.md
  • Loading branch information
djperrefort authored Oct 25, 2022
1 parent 618962d commit 6bb59f8
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,20 @@ headers and the routing destination are configurable via the standard Jupyter co

## Installation and Setup

The `crc_jupyter_auth` package is installable via the `pip` package manager.
The latest development version of the `crc_jupyter_auth` package can be installable via the `pip` package manager.

```bash
git clone https://github.com/pitt-crc/Jupyter-Authenticator.git
pip install Jupyter-Authenticator
pip install git+https://github.com/pitt-crc/Jupyter-Authenticator.git
```

Older versions can be installed by checking out the appropriate release tag via `git`:
Specific release versions can be installed by specifying the github tag name.
Replace `[TAGNAME]` with a release tag in the below example:

```bash
cd Jupyter-Authenticator
git fetch
git checkout tags/[RELEASETAG]
pip install .
pip install git+https://github.com/pitt-crc/Jupyter-Authenticator.git@tags/[TAGNAME]
```

Update the `authenticator_class` option in your Jupyter configuration file to reflect the installed package.
After installing the package, you will need to update the `authenticator_class` option in your Jupyter configuration file.
To enable basic authentication capabilities and request routing, specify the `RemoteUserAuthenticator` class:

```bash
Expand Down

0 comments on commit 6bb59f8

Please sign in to comment.