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.

Sign up for GitHub

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

installation doc: add link to existing SSO doc #1453

Merged
merged 3 commits into from
Nov 26, 2024
Merged

installation doc: add link to existing SSO doc #1453

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
828b9e2
added link to SAML/SSO doc, and moved Ruby version info to near the p…
cellio Nov 20, 2024
b9499e8
Merge branch 'develop' into cellio/add-sso-to-installation-doc
Oaphi Nov 26, 2024
feeddc2
review comments
cellio Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ If you don't already have Ruby installed, use [RVM](https://rvm.io/) or
[rbenv](https://github.com/rbenv/rbenv#installation) to install it before following
these instructions.

QPixel is tested with Ruby 3 (and works with Ruby 2.7 as of December 2022).

## Prerequisites

For Debian-Based Linux:
Expand Down Expand Up @@ -43,7 +45,6 @@ brew install mysql bison openssl mysql-client
bundle config --global build.mysql2 --with-opt-dir="$(brew --prefix openssl)"
```

QPixel is tested with Ruby 3 (and works with Ruby 2.7 as of December 2022).

## Environment

Expand Down Expand Up @@ -120,7 +121,7 @@ After downloading QPixel, you need to install all the dependencies. For that, yo
If Ruby complains, that the Bundler hasn't been installed yet, use `gem install bundler` and
then re-run the above command.

### Setting up the Database
### Set up the Database

If you weren't asked to set the root MySQL user password during `mysql-server` installation,
the installation is likely to be using Unix authentication instead. You'll need to sign into
Expand Down Expand Up @@ -213,6 +214,11 @@ When you've met the length requirements and added a tag, the "Save Post in Q&A"
![img/post.png](img/post.png)


## Optional: Single Sign On

You can [set up SAML Single Sign On](https://github.com/codidact/qpixel/wiki/Setting-up-SAML-Single-Sign-On).
Oaphi marked this conversation as resolved.
Show resolved Hide resolved


## Optional: Required Tags

The special Meta tags (discussion, bug, support, feature-request) are not seeded. (We do not assume that all deployments want to manage user feedback the same way.) You can create tags directly on the Meta Tags page:
Expand Down
Loading