Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for external authentication SSO Backend to get a proper install #159

Closed
syyna opened this issue Mar 16, 2021 · 2 comments · Fixed by #218
Closed

Update documentation for external authentication SSO Backend to get a proper install #159

syyna opened this issue Mar 16, 2021 · 2 comments · Fixed by #218
Assignees
Labels
type: bug Something isn't working as expected type: documentation Improvements or additions to documentation
Milestone

Comments

@syyna
Copy link

syyna commented Mar 16, 2021

Environment

  • Python version: 3.8.5
  • Nautobot version: 1.02b

Steps to Reproduce

  1. Follow steps to install SAML SSO backend in https://nautobot.readthedocs.io/en/latest/configuration/authentication/sso/
  2. Run into several issues due to incomplete documentation of dependencies to install

Expected Behavior

Following the doc should get me to the intended next step

Observed Behavior

Following the doc led me to an error

Fix

These are the proper steps for SAML dependencies for external authentication:
Using sudo outside the venv

  1. sudo apt install -y libxml2-dev libxmlsec1-dev libxmlsec1-openssl pkg-config

Switching to user nautobot and installing within the venv.
2. sudo -iu nautobot
3. source bin/activate
4. pip install testresources
5. pip install --upgrade pip setuptools wheel
6. pip install python3-saml

This is tested on ubuntu 20.04 with the base nautobot install using the nautobot install docs.

@jathanism jathanism added type: documentation Improvements or additions to documentation type: bug Something isn't working as expected labels Mar 16, 2021
@jathanism
Copy link
Contributor

Thanks @syyna for the report! 👀

@jathanism jathanism added this to the v1.0.0 milestone Mar 16, 2021
@jathanism jathanism self-assigned this Mar 16, 2021
@dgjustice
Copy link
Contributor

This is related to issue #149

@jathanism jathanism added this to To do in Release v1.0.0 Mar 24, 2021
@jathanism jathanism moved this from To do to In progress in Release v1.0.0 Mar 25, 2021
Release v1.0.0 automation moved this from In progress to Done Apr 2, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 2, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: bug Something isn't working as expected type: documentation Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

3 participants