USP Core Authenticate

Welcome to the USP Core Authenticate customer documentation repository. This repository contains the scripts required to build the USP Core Authenticate website:

• https://united-security-providers.github.io/usp-core-authenticate/

Requirements

• mkdocs to generate the website and deploy it to GitHub pages.

mkdocs notes

• Do NOT install mkdocs as a system package (e.g. Debian package). Those are often older releases. Install it with the Python package manager "pip" instead. Also, install all the required Python packages as well.

• mkdocs installation guide: https://www.mkdocs.org/user-guide/installation/#installing-mkdocs

Install / upgrade pip

python get-pip.py
pip install --upgrade pip

Install mkdocs

pip install mkdocs
pip install pymdown-extensions
pip install mkdocs-material
pip install mkdocs-redirects
pip install mkdocs-swagger-ui-tag

NOTE: You may need to log out and log in again to get the mkdocs executable in your PATH. Check by running

mkdocs --version
mkdocs, version 1.5.3 from /home/<myuser>/.local/lib/python3.10/site-packages/mkdocs (Python 3.10)

Generate site locally

To just generate the site locally, run:

$ ./release.sh {core-authenticate-version}

The site has then been generated within the "build" directory (Markdown source for mkdocs, not yet HTML).

Test site locally

Generate the site locally as described above, then run mkdocs to serve it locally:

$ ./release.sh
$ mkdocs serve

This will make it available locally (URL visible in output on the shell, typically http://127.0.0.1:8000/).

Generate site and publish it via GitHub

To generate the site and deploy it to GitHub pages, run:

$ ./release.sh {core-authenticate-version} deploy