Commit graph

28 commits

Author SHA1 Message Date
Steven Palmesano
da01caf3c0
Clarify what the Entity ID is (#44012)
The most common misunderstanding that our users have when configuring
SSO (specifically Okta, since it refers to the value by a different
name) is what to put in this Entity ID field. If it doesn't match the
IdP's version, SSO will fail.

We were also directing users to retrieve an issuer URI, which would
presumably be used as the Entity ID. The problem is, the rest of our
docs don't state that, and instead tell users to use a simple value such
as `fleet`.
2026-05-04 16:18:00 -05:00
Steven Palmesano
6a0471c120
Keep Entity ID consistent (#37936)
Users run into issues when trying to configure SSO, because we use
Entity ID three different ways in our docs.
2026-01-27 16:12:23 -06:00
Josh Roskos
ed17e84d05
Update SSO configuration paths in documentation (#36894)
Updates from customer call today: 
  - Updated image to reference `Fleet users` callback URL
  - Updated *Fleet configuration* instructions for UI changes
2025-12-08 14:04:49 -06:00
Josh Roskos
7117e6dede
Updated okta-idp-setup.png to reference correct URL (#36647)
Came up during customer interaction, updated screenshot to show what we
also include in the comment box below.
2025-12-04 16:38:27 -06:00
Dale Ribeiro
33eb54d013
Update single-sign-on-sso.md (#27784)
# Checklist for submitter

If some of the following don't apply, delete the relevant line.

<!-- Note that API documentation changes are now addressed by the
product design team. -->

- [ ] Changes file added for user-visible changes in `changes/`,
`orbit/changes/` or `ee/fleetd-chrome/changes`.
See [Changes
files](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/Committing-Changes.md#changes-files)
for more information.
- [ ] Input data is properly validated, `SELECT *` is avoided, SQL
injection is prevented (using placeholders for values in statements)
- [ ] Added support on fleet's osquery simulator `cmd/osquery-perf` for
new osquery data ingestion features.
- [ ] If paths of existing endpoints are modified without backwards
compatibility, checked the frontend/CLI for any necessary changes
- [ ] If database migrations are included, checked table schema to
confirm autoupdate
- For database migrations:
- [ ] Checked schema for all modified table for columns that will
auto-update timestamps during migration.
- [ ] Confirmed that updating the timestamps is acceptable, and will not
cause unwanted side effects.
- [ ] Ensured the correct collation is explicitly set for character
columns (`COLLATE utf8mb4_unicode_ci`).
- [ ] Added/updated automated tests
- [ ] A detailed QA plan exists on the associated ticket (if it isn't
there, work with the product group's QA engineer to add it)
- [ ] Manual QA for all new/changed functionality
- For Orbit and Fleet Desktop changes:
- [ ] Make sure fleetd is compatible with the latest released version of
Fleet (see [Must
rule](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/fleetd-development-and-release-strategy.md)).
- [ ] Orbit runs on macOS, Linux and Windows. Check if the orbit
feature/bugfix should only apply to one platform (`runtime.GOOS`).
- [ ] Manual QA must be performed in the three main OSs, macOS, Windows
and Linux.
- [ ] Auto-update manual QA, from released version of component to new
version (see [tools/tuf/test](../tools/tuf/test/README.md)).
- [ ] For unreleased bug fixes in a release candidate, confirmed that
the fix is not expected to adversely impact load test results or alerted
the release DRI if additional load testing is needed.

---------

Co-authored-by: Brock Walters <153771548+nonpunctual@users.noreply.github.com>
2025-04-04 18:04:18 -05:00
Gabe Lopez
f51bb7c7ea
Add files via upload to replace old screenshot for SSO config (#26841)
Replacing an old screenshot for SSO-Setup that removes the `issuer URI`
field that is no longer needed nor available in Fleet

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
2025-03-06 13:28:57 -06:00
Noah Talerman
ec43ee288b
SSO guide: best practice for email 2FA (#25005)
Fleet shipped email 2FA. User story is here (#22078)

- Add best practice to guides:
  - Email 2FA for "break-glass" user
  - SSO for all other users
- Update pricing page to link to feature request instead of the user
story.

---------

Co-authored-by: Marko Lisica <83164494+marko-lisica@users.noreply.github.com>
2024-12-25 11:55:24 +01:00
Mike Thomas
9802ccc37a
Migrate deployment guides to articles (#19007)
This PR is a follow-up to https://github.com/fleetdm/fleet/issues/16660
to:

- Move all (non-recommended) deployment guides from the docs into
`/articles` under the `guides` category
    - AWS ECS
    - CentOS
    - Cloud.gov
    - AWS with Terraform
    - Hetzner Cloud
    - Render
    - Kubernetes
- Set up redirects for migrated articles
- Add article thumbnail and cover images

# Checklist for submitter

- [x] Manual QA for all new/changed functionality

---------

Co-authored-by: Rachael Shaw <r@rachael.wtf>
Co-authored-by: Eric <eashaw@sailsjs.com>
2024-05-16 07:29:51 +09:00
Mike Thomas
458dcfd366
Migrate Deploy Fleet on Hetzner Cloud (#13021)
This is the last of three PRs to migrate the deployment guides into the
docs.

Changes:

- Moved content from `/articles/deploying-fleet-on-hetzner-cloud.md` to
`/docs/deploy-on-hetzner-cloud.md`.
- Removed `/articles/deploy-fleet-on-hetzner-cloud.md`.
- Moved images from the guide to `/docs/images` and renamed.
- Deleted redundant images and article cover image.
- Set up a redirect `/deploy/deploying-fleet-on-hetzner-cloud` =>
`/docs/deploy/deploy-on-hetzner-cloud`.
- Set up a redirect `/deploy` => `/docs/deploy` to redirect "Deployment
guides" in the main nav to the docs.
- Updated display names (in the docs nav) for existing deployment guides
in the docs to match the naming convention (E.g., "Deploy Fleet on
CentOS" => "CentOS")
- Removed the deployment guides article category from the blog.

# Checklist for submitter

- [ ] Manual QA for all new/changed functionality

---------

Co-authored-by: Eric <eashaw@sailsjs.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-08-30 19:17:22 -05:00
Noah Talerman
b87c28726a
Docs: Add instructions for MDM migration (#9708)
These docs address 5 out of 7 requirements in the "Docs for MDM
migration" issue here: #9009

Docs also add an "Instructions for end users" section to address docs
for "Manual enrollment" issue:
https://github.com/fleetdm/fleet/issues/7957#issuecomment-1416262879

- Add instructions for IT admins on how to switch MDM solutions for
hosts manually enrolled to the old MDM solution
- Add instructions for IT admins on how to switch MDM solutions for
hosts automatically enrolled (DEP) to the old MDM solution
- Add information for IT admins about how Fleet treats Activation Lock
Bypass codes
- Add instructions for end users on how to switch MDM solutions for
hosts manually and automatically enrolled to the old MDM solution (same
instructions)
2023-02-07 13:53:14 -06:00
Noah Talerman
f11a905a09
Docs: MVP for MDM page (#9417)
- Add new "Mobile device management (MDM)" page to "Using Fleet" section
- Adds docs for OS updates
2023-01-19 17:50:06 -05:00
Noah Talerman
24c0dfa603
Update using-fleet/fleet-ui doc page (#7599)
- Add "Create a query" and "Run a query" sections
- Update "Schedule a query" section
- Remove unused images from `docs/images/`.
2022-09-09 10:14:40 -04:00
Mike Thomas
933c373e0c
Update fleet-architecture-diagram.png (#6871)
Updated Fleet architecture diagram.
2022-07-28 10:03:16 +09:00
Olivia Brundage
3d584960f8
Update SSO Documentation (#5583)
* update sso image

* clairfy how to find Okta information

* moving comment about user creation since it applies to all IdP configurations

* change url image link to default link

Co-authored-by: Kelvin Oghenerhoro Omereshone <kelvin@fleetdm.com>
2022-06-03 11:26:24 -05:00
Kelvin Oghenerhoro Omereshone
f4d130dde9
Update stale screenshots (#4294)
* docs: add new manage-packs.png

* feat: add new team-agent-options.png

* feat: add new global-agent-options.png

* docs: update screenshots and docs context

* chore: delete stale screenshots

* feat: update screenshot to recommended preset size

* chore: remove editor new line

* feat: update new line
2022-02-18 16:25:53 +01:00
Kelvin Oghenerhoro Omereshone
7af7d5f25d
Feature/add architecture diagram (#4222)
* feat: add fleet architecture diagram

* feat: add Fleet architecture diagram to deployment guide
2022-02-15 23:37:49 +01:00
eashaw
ac45bc0706
Docs image updates (#2297)
* addred cropped images to replace images in configuration.md, fixed duplicated alt text, added box-shadow to images

* more cropping

* reduce padding on ordered lists, point urls in markdown to where images will be

* Update 02-Configuration.md

* Update build-static-content.js

* remove box-shadow on images

* Update 02-Configuration.md

* Added handbook entry about images

* changed img tags to markdown links to be consistent

* undo small style change

* Update build-static-content.js

* Update handbook/product.md

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>

Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
2021-10-05 08:25:34 +09:00
noahtalerman
6c22965917
Update screenshots and verbiage in Configuring Single Sign On documentation (#1396)
- Add new example Okta configuration screenshot
- Add new example Fleet configuration screenshot
2021-07-15 15:55:12 -04:00
Mike Thomas
27c3a6dcd8
Remove legacy images from docs (#1296) 2021-07-06 07:13:48 +09:00
noahtalerman
be2cf92b37
Add documentation for setting global and team agent options in Fleet UI (#1190)
- Add "Configuring agent options" section to `/1-Using-Fleet/1-Fleet-UI.md`
- Add 2 screenshots: 1. Global agent options form 2. Team agent options form
2021-06-24 13:59:41 -04:00
William Theaker
f3ef70358a
Replace Okta image, compress others. (#1166) 2021-06-23 08:27:45 -07:00
noahtalerman
9ec90bfe6e
Provide documentation for reporting issues with the Fleet UI (#613)
- Add 2 sections in `CONTRIBUTING.md` these 2 sections correspond to the "Bug report" and "Report a security vulnerability" issue templates
- Add "Is this an issue with the Fleet UI" to "Bug report" section in `CONTRIBUTING.md`. This includes a walkthrough for opening the browser's JS console and network requests
- Fix misspelled file name
2021-04-07 16:30:32 -07:00
noahtalerman
e4a5ed7125
Add new screenshot (#525)
- Add new screenshot of the "Add new host" modal to /2-Deployment/4-Example-deployment scenarios docs
Closes #487
2021-03-23 16:20:00 -07:00
Mike Thomas
1ec7557dfd
Updated documentation screens (#521)
Updated screens in Using Fleet documentation to reflect updated UI.
2021-03-23 09:02:39 -05:00
William Theaker
12f288730f Update SAML documentation (#2113)
Provide details for Okta and split out Salesforce example.
2019-10-11 15:14:56 -07:00
John Murphy
019191c36b SSO Login and Configuration Support (#1506)
Closes issue #1456 This PR adds a single sign on option to the login form, exposes single sign on to the end user, and allows an admin user to set single sign on configuration options.
2017-05-17 10:58:40 -05:00
Mike Arpaia
8f433d81ae Cursory application documentation (#1165)
* Running Queries

* Scheduling Queries

* Configuring Osquery Options

* Working With Osquery Logs

* kolide for the osquery user
2017-02-02 15:13:54 -07:00
Mike Arpaia
e17ab76cff Setting up and using Kolide (#1133) 2017-01-30 18:51:10 -07:00