Commit graph

53 commits

Author SHA1 Message Date
Katheryn Satterlee
ad57147360
Add note about async logging (#9983)
Docs only change
2023-02-21 11:56:24 -06:00
Katheryn Satterlee
1d77b135ed
Update Audit Logging configuration docs (#9737)
Added note about the availability of audit logs and links to the
appropriate section for each logging destination.

Documentation-only change
2023-02-21 11:09:06 -06:00
Lucas Manuel Rodriguez
1f97514200
Only set public IPs on host.public_ip and add docs (#9900)
#9857

The "Public IP address" field is sometimes set to a "Private IP" on the
following types of Fleet deployments:
- Local deployments.
- Deployments where Fleet is on a private network.
- Deployments where an agent connects to Fleet not via the public
internet.

This PR will prevent a private IP to be set on the `host.public_ip`
field.
And this PR also adds documentation on how Fleet deduces the public IPs
of the devices so that a user can make the changes to fix this.

- [X] Changes file added for user-visible changes in `changes/` or
`orbit/changes/`.
See [Changes
files](https://fleetdm.com/docs/contributing/committing-changes#changes-files)
for more information.
- ~[ ] Documented any API changes (docs/Using-Fleet/REST-API.md or
docs/Contributing/API-for-contributors.md)~
- ~[ ] Documented any permissions changes~
- ~[ ] 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.~
- ~[ ] Added/updated tests~
- [X] Manual QA for all new/changed functionality
  - ~For Orbit and Fleet Desktop changes:~
- ~[ ] 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)).~
2023-02-17 13:00:56 -03:00
Benjamin Edwards
0db432f7e3
vuln processing distinct command (#9813)
closes https://github.com/fleetdm/fleet/issues/3723

Add new vuln processing command, configs, and documentation on how to utilize.
2023-02-17 10:00:57 -05:00
Katheryn Satterlee
e4a8bf4130
Add note about Orbit host identifier (#9882)
Added a note reccomending `uuid` as host identifier when using Fleet
generated packages. Resolves #9033
2023-02-16 11:03:48 -06:00
RachelElysia
2c4c3a87ea
Fleet Documentation: Update agent options and enrollment secret documentation (#9565) 2023-02-13 10:45:37 -05:00
Katheryn Satterlee
237a97d07a
Update osquery interval warning (#9485)
Docs only change
2023-01-24 16:27:10 -06:00
Katheryn Satterlee
891bd97e1d
Add note to osquery update intervals (#9484)
Added a note about potential performance degradation when update
intervals are lowered.
2023-01-24 16:21:09 -06:00
Noah Talerman
d513763445
Docs: Update MDM settings and configuration (#9416)
- Add callout that MDM features are currently under development
- Rename sections
2023-01-19 13:34:18 -05:00
Lucas Manuel Rodriguez
e1bbcfcfda
Generate audit logs for activities (#9001)
* Generate audit logs for activities

* Fix config tests

* Fix TestGetConfig/IncludeServerConfig

* Fix use of AddAttributes in results only

* Stream activities asynchronously

* Fix index and add logging

* Revert change

* Documentation fixes
2022-12-23 19:04:13 -03:00
Stephan Miehe
b6a409fa3b
Support redis username (#9018) 2022-12-14 08:53:38 -05:00
Martin Angers
d4a3730610
Add new configuration options for Apple Business Manager (#8886) 2022-12-06 15:50:56 -05:00
Martin Angers
f5fc316ad3
Add options for configuring APNS and SCEP keys/certs in Fleet server (#8730) 2022-12-05 10:22:56 -05:00
Eric
52da2a3108
change relative links in documentation (#8441) 2022-10-26 18:26:49 -05:00
Noah Talerman
d354f62ca0
Update session_duration docs (#8339)
Addresses #5476
2022-10-20 15:51:51 -04:00
Noah Talerman
c576b9de20
Update log destination docs (#8242)
- Rename "Osquery logs" page to "Log destinations"
- Use exact product names in the log destination docs
- Move anchor links to the top of the page so that fleetdm.com/docs/log-destinations renders a sidebar
2022-10-18 13:18:15 -04:00
Martin Angers
988f50fa34
Document all keys in config and team YAML documents (#7449)
- Add a new "Configuration for contributors" doc page. Move settings that are not recommended for production use
- Remove settings modified in the `config` YAML document from the deploying/configuration doc page
- Document all keys in `config` and `teams` YAML documents
- Add comments to several `.go` files and remove unused struct
2022-09-08 17:57:38 -04:00
Roberto Dip
7c0b47e568
add note in JIT SSO docs about this being a premium feature (#7653) 2022-09-08 14:22:32 -05:00
Mo Zhu
723b76cd2c
Fix JIT user creation docs (#7617)
- Lowercase "Login"
- Fix link formatting
2022-09-07 15:47:36 -04:00
Michal Nicpon
0709d1bc5c
improve vuln cpe matching on macos (#6985)
* add cpe translations
* fix matching on target_sw
2022-09-01 10:02:07 -06:00
Juan Fernandez
3048a07fd1
Feature 7076: Ingest installed windows updates (#7138)
* Ingest installed Windows updates and store them in the windows_updates table. 
* Added config option for enabling/disabling Windows update ingestion and Windows OS vuln. detection.
2022-08-26 14:55:03 -04:00
Noah Talerman
b0e37accc9
Update "Learn how to use Fleet" for Fleet Sandbox (#7142)
- Update "Learn how to use Fleet" docs page to walk a Fleet Sandbox user through adding their device and running a query
- Add a "Get operating system information" query to standard query library for the "Learn how to use Fleet" walkthrough
- Update Fleet's top level README to point users who want to try Fleet to Fleet Sandbox
- Update "How to install osquery..." (macOS, Windows, Linux) blog posts to point users who want to try Fleet to Fleet Sandbox
- Move `fleetctl preview` questions to "Contributing" FAQ section in docs. This is because `fleetctl preview` is now a testing tool for Fleet contributors
- Update "Deploying" docs to point users who want to try Fleet to Fleet Sandbox
2022-08-19 14:13:15 -04:00
Roberto Dip
5371e9c927
add UI and documentation for JIT provisioning (#7189)
Related to #7054 and #6834, this adds the UI changes necessary to support JIT provisioning:

    A checkbox in the settings page
    A new template for the activity box

This also includes relevant documentation about the feature and how to configure it.
2022-08-15 15:26:55 -03:00
Martin Angers
9755eb2e27
Support async saving of scheduled query statistics (#7012) 2022-08-10 10:01:05 -04:00
Eric
46aa36356b
Website: Update LANG markers regex in build-static-content.js (#6785)
* Update LANG markers regex

* update regex to remove extra newlines from codeblocks

* revert regex in build-static-content

* remove nested codeblock

* update whitespace in changed codeblock

* update regex replace to match indentation on LANG tags

* update regex, add error if markdown was compiled with nested codeblocks

* Revert lang marker regex

* remove newlines before codeblocks in lists

* Update error, move LANG tag regex replace

* update comment to clarify what we mean by nested codeblocks

Co-authored-by: Mike McNeil <mikermcneil@users.noreply.github.com>
2022-07-27 16:55:06 -05:00
Desmi-Dizney
cc916ffb96
Docs editor pass - Deploying - Configuration (#6561)
This is still in progress. Please do not merge yet.
2022-07-21 13:52:53 -05:00
Desmi-Dizney
77bc656ae5
Editor pass - add configuration to retrieve installers from S3 (#6762)
Editor pass for:
-  https://github.com/fleetdm/fleet/pull/6630
2022-07-21 10:31:35 -05:00
Michal Nicpon
e3e17f3389
Fix double quote usage in sql query (#6707) 2022-07-20 10:10:03 -06:00
Roberto Dip
7e68ee2253
add configuration to retrieve installers from S3 (#6630)
Related to #6365, this adds relevant configuration to the packaging key to retrieve installers from S3.
2022-07-13 09:34:25 -03:00
Roberto Dip
6faee84f57
allow to configure a default global enroll secret (#6609)
Related to #6365 this adds a new config to set a global enroll token that will be used by the server.
2022-07-12 19:12:10 -03:00
Desmi-Dizney
4eb5f74440
Editor pass - Docs - Deploying - Configuration - Single-sign-on (#6377)
This has been edited for copy as per @mikermcneil's request.
2022-06-28 17:27:14 -04:00
Desmi-Dizney
845e9e6e0e
Editor pass - Track active hosts count and enforce limit (#6224)
This has been edited for copy.
2022-06-14 14:58:34 -04:00
Martin Angers
81f0e0ccfa
Track active hosts count and enforce limit (#6099) 2022-06-13 16:29:32 -04:00
Desmi-Dizney
03d2e3b91c
Editor pass - Update SSO Documentation (#6092)
Editor pass for:
-  https://github.com/fleetdm/fleet/pull/5583
2022-06-06 14:19:09 -07: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
Desmi-Dizney
f648949ebe
Editor pass - Support per-task configuration for async host processing configuration (#5810)
* Editor pass - Support per-task configuration for async host processing configuration #

Editor pass for:
-  https://github.com/fleetdm/fleet/pull/5700

* Update Configuration.md

* Update config.go
2022-05-20 12:07:32 -05:00
Desmi-Dizney
a3b371e415
Editor pass - Support async saving of hosts' last seen time (B) (#5752)
Editor pass for:
-  https://github.com/fleetdm/fleet/pull/5640
2022-05-20 09:31:46 -04:00
Martin Angers
e6b90ca8b9
Support per-task configuration for async host processing configuration (#5700) 2022-05-16 09:44:50 -04:00
Martin Angers
1fa7bb7a19
Support async saving of hosts' last seen time (#5640) 2022-05-10 11:29:17 -04:00
Desmi-Dizney
a986615a7d
Editor Pass - Add osquery.min_software_last_opened_at_diff configuration option (1) (#5416)
Editor pass for: https://github.com/fleetdm/fleet/pull/5394 - docs/Deploying/Configuration.md
2022-04-29 09:18:50 -05:00
Martin Angers
0d0c17e0c6
Add osquery.min_software_last_opened_at_diff configuration option (#5394) 2022-04-27 09:47:09 -04:00
Desmi-Dizney
37556db4e7
Editor pass - Revert api v1 to latest in documentation (#5316)
Editor pass for:  https://github.com/fleetdm/fleet/pull/5149
2022-04-26 15:51:13 -05:00
Michal Nicpon
cc249e0ff1
revert api v1 to latest in documentation (#5149)
* revert api v1 to latest in documentation

* Update fleetctl doc page

Co-authored-by: Noah Talerman <noahtal@umich.edu>
2022-04-14 16:33:52 -05:00
Martin Angers
36702ede8d
Make recent vulnerabilities max age configurable. (#5081) 2022-04-12 14:48:15 -04:00
Lucas Manuel Rodriguez
60b7425bef
Add http basic auth to /metrics (#4974)
* Add http basic auth to /metrics

* Fixes after testing applying of a --config sample.yml

* Add unit test
2022-04-07 09:40:53 -03:00
Martin Angers
90b15071a4
Introduce API version 2022-04, deprecate use of /global in paths (#4731) 2022-04-05 11:35:53 -04:00
Katheryn Satterlee
d3454bcfce
Weekly community-driven documentation update for week ending March 25th (#4818)
* Weekly community-driven docs update for week ending March 25th

* Update Configuration.md

* Update FAQ.md

All edits are recorded by line:
192 added “-“ to “auto-updates”
194 added “-“ to “auto-updates”; deleted “,” after “(easy)”; replaced “reccomend” with “recommend”
209 added “,” after “work”
211 replaced “am I seeing” with “do I see”
225 replaced “The best way to maintain historical data currently would be to use the [REST API](./REST-API.md) or the [`fleetctl` CLI](./fleetctl-CLI.md) to manually retrieve and save the data you need on your schedule. “ with “Currently, Fleet only stores the current state of your hosts (when they last communicated with Fleet). The best way at the moment to maintain historical data would be to use the [REST API](./REST-API.md) or the [`fleetctl` CLI](./fleetctl-CLI.md) to retrieve it manually. Then save the data you need to your schedule.”

* Update FAQ.md

All edits are recorded by line:
194 deleted ”either” after “disabled”

* Update fleetctl-CLI.md

All edits are recorded by line:
28 deleted “of the” after “many”; replaced “User Interface” with “UI(User Interface)”; replace “, and to” with “. You can even”
43 capitalized “Fleet”
63 replaced “info” with “information”

* Additional context for help menu and add table

Tweaked wording around using the help command and moved available commands in to a table. @DominusKelvin @Desmi-Dizney

* Update Configuration.md

space

* Final grammar revision

Co-authored-by: Desmi-Dizney <99777687+Desmi-Dizney@users.noreply.github.com>
2022-03-31 10:34:58 -05:00
Noah Talerman
8e9a814d4b
Prepare for 4.12.0 (#4797)
- Update CHANGELOG
- Bump versioning
- Tweak documentation
  - Default `session_duration` to `5d`
  - Add extra `#` to "Team policies" section so it doesn't show up in top level nav for docs
2022-03-24 17:24:08 -07:00
Zach Wasserman
e2ec9df037
Update systemd example to show running as a non-root user (#4702)
From discussion in https://osquery.slack.com/archives/C01DXJL16D8/p1647507818040759.
2022-03-21 10:49:42 -07:00
Benjamin Edwards
74bb559645
Add public ip to hosts & derive geolocation when rendering host (#4652)
* geoip wip
* return nil if ip is empty string or if ParseIP returns nil
* add ui component to render geolocation if available, address PR feedback
* render public ip if available
* add changes file, document geoip in deployment guide
* update rest-api docs
2022-03-21 12:29:52 -04:00