Commit graph

398 commits

Author SHA1 Message Date
Zach Wasserman
2d22020973
Update live query API documentation (#1745)
Attempt to add clarity to the process of using the API to run live queries.
2021-08-19 16:39:17 -07:00
Zach Wasserman
23fabff12a
Update host API doc (#1744)
Include software inventory and users in example response.
2021-08-19 16:22:17 -07:00
noahtalerman
4836864db6
Fix anchor links for "Get enroll secrets" and "Modify enroll secrets" sections in API docs (#1738) 2021-08-19 17:03:35 -04:00
Mike Thomas
7b3b24547d
Updated product name on website and docs (#1731)
Updated product name on website and docs
2021-08-19 12:50:21 -05:00
Mike Thomas
9bef2a1a1b
update-ask-questions-about-your-devices.md (#1734)
Changes name to "0-Learn-how-to-use-Fleet.md," moved into "1-Using-Fleet" folder, and deleted "Tutorials" folder.
2021-08-19 23:39:22 +09:00
Mike Thomas
457ba20aa0
Update Ask-questions-about-your-devices.md (#1733)
* Update Ask-questions-about-your-devices.md

Further edited the doc for tone and grammar.
Added section about enrolling your own device.

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>
2021-08-19 22:27:53 +09:00
Zach Wasserman
403f9d2c74
Clarify Safari in supported browsers doc (#1725) 2021-08-18 17:29:25 -07:00
noahtalerman
3725781597
Move vulnerabilities configuration options into 2-Deploying/2-Configuration.md (#1722)
- Move vulnerabilities config options into `2-Deploying/2-Configuration.md` and link to these options from the Vulnerability processing docs
2021-08-18 17:16:59 -04:00
Tomas Touceda
70f728fe84
Make vulnerability processing more configurable (#1718)
* Make vulnerability processing more configurable

* Simplify leader selection
2021-08-18 17:25:14 -03:00
Mike McNeil
8097251565
Put live documentation on fleetdm.com (#1380)
* minor clarifications

* further expand comments and stubs

* absorb custom titles embedded in metadata, plus further comment expansion and a followup fix for something i left hanging in f8cbc14829

* Skip non-markdown files and use real path maths

* Prep for running in parallel (Remove `continue` so this isn't dependent on the `for` loop)

* determine + track unique HTML output paths

* Compile markdown + spit out real HTML  (without involving any but the crunchy nougaty dependency from the very center of everything)

* add md metadata parsing

* add timestamp

* Update build-static-content.js

* attach misc metadata as "other"

* how doc images might should work (this also aligns with how the select few images in the sailsjs.com docs work)

* add file extension to generated HTML files

* "options"=>"meta"

* Make "htmlId" useful for alphabetically sorting pages within their bottom-level section

See recent comments on https://github.com/fleetdm/fleet/issues/706 for more information.

* list out the most important, specific build-time transformations

* Omit ordering prefixes like "1-" from expected content page URLs

* add a little zone for consolidating backwards compatible permalinks

* interpret README.md files by mapping their URLs to match their containing folder

* clarify plan for images

* decrease probability of collisions

* Make capitalization smarter using known acronyms, proper nouns, and a smarter numeric word trim

* Resolve app path in case pwd is different in prod

* Delete HTML output from previous runs, if any

* condense the stuff about github emojis

* got rid of "permalink" thing, since id gets automatically attached during markdown compilation anyway

Also "permalink" isn't even a good name for what this is.  See https://github.com/fleetdm/fleet/issues/706#issuecomment-884693931

* …and that eliminates the need for the cheerio dep!

* Bring in bubbles+syntax highlighting into build script, and remove sails.helpers.compileMarkdownContent()  -- this leaves link munging as a todo though

* trivial (condense comments)

* Remove unused code from toHtml() helper

* Implemented target="_blank" and root-relative-ification

* remove todo about emojis after testing and verifying it works just fine

* trivial: add link to comment in case github emojis matter at some point

* consolidate "what ifs" in comments

* Leave this up to Sarah, for now. (Either bring it back here in the build script or do it all on the frontend)

* Enable /docs and /handbook routes, and add example of a redirect for a legacy/deprecated URL

* implement routing

* Upgrade deps

this takes advantages of the latest work from @eashaw, @rachaelshaw, and the rest of the Sails community

* tweak var names and comments

* make readme pages use their folder names to determine their default (fallback) titles

as discussed in https://github.com/fleetdm/fleet/issues/706#issuecomment-884788002

* first (good enough for now) pass at link rewriting

as discussed in https://github.com/fleetdm/fleet/issues/706#issuecomment-884742072

* Adapt docs pages to build from markdown output

* Continue work on docs pages

* Add landing page

* Remove unused code; minor changes

* Replace regex

* fixes https://github.com/fleetdm/fleet/pull/1380#issuecomment-891429581

* Don't rely on "path" being a global var

* Syle fleetdm doc pages

* Continue work on docs pages

* Fix linting error

* Disable lesshint style warnings

* parasails-has-no-page-script attribute

Added a parasails-has-no-page-script attribute to the docs template, added a check for that attribute in parasails.js and removed the empty page script for 498

* bring in latest parasails dep

* trivial

* Update links to dedupe and not open in new tab unless actually external

* Disable handbook for now til styles are ready

* fix CTA links

* trivial

* make sitemap.xml get served in prod

* hide search boxes for now, remove hard-coded version and make releases open in new tab

* clean out unused files

Co-authored-by: gillespi314 <73313222+gillespi314@users.noreply.github.com>
Co-authored-by: eashaw <caglc@live.com>
2021-08-17 19:55:13 -05:00
Martin Angers
ed428d707b
Clarify a few points in the Contributing docs (#1692)
Document that `fleet serve --dev` requires `make generate-dev` and
that for changelog we now use changes files.
2021-08-16 14:59:03 -04:00
RachelElysia
7d23ff2b53
Align API docs and frontend interfaces with API GET responses (#1602) 2021-08-16 10:30:19 -04:00
Zach Wasserman
9a5842d9c3
Document minimal online keys for Orbit updates (#1678) 2021-08-15 16:47:24 -07:00
Benjamin Edwards
2d5c7ed683
issue 1313 -- add file destination for convert command (#1672)
* add file destination flag for convert command, add tests
* add changes file
* remove leftover debugging code, add comment explaing why sorting was necessary
* update docs for fleetctl convert
* Update cmd/fleetctl/convert_test.go
Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-08-13 20:42:58 -04:00
noahtalerman
b2c7faf251
Update "Ask questions about your devices" walkthrough and update API docs (#1670)
- Remove "How to add Fleet's standard query library" section from the "Ask questions about your devices" walkthrough.
- Add `license`, `vulnerability_settings`, and `logging` properties to the example response for the `GET /api/v1/fleet/config` and `PATCH /api/v1/fleet/config` API routes
2021-08-13 15:01:53 -04:00
noahtalerman
e2e812d9c2
Add correct query (#1669)
- Replace incorrect query
2021-08-13 15:00:46 -04:00
Mike Thomas
4cb315e2f1
Update 12-Supported-browsers.md (#1653)
Grammar/typo fix.
2021-08-11 20:26:29 -05:00
Mike Thomas
bc24e88b66
Update Ask-questions-about-your-devices.md 2021-08-12 10:20:54 +09:00
noahtalerman
2df7c71749
Prepare for Fleet 4.2.0 (#1645) 2021-08-11 17:14:32 -07:00
Zach Wasserman
544652e833
Clarify label responses and API docs (#1633)
- Include platform and description even when empty in API responses.
- Update docs to indicate immutability.
2021-08-11 14:57:05 -07:00
Mike Thomas
1d6aa19990
Update Ask-questions-about-your-devices.md 2021-08-12 06:34:24 +09:00
Mike Thomas
dca5aac6e1
Update Ask-questions-about-your-devices.md (#1642)
* Update Ask-questions-about-your-devices.md

Added screenshots.

* Update Ask-questions-about-your-devices.md

changed to img tags for better control of sizing.

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md

* Update docs/1-Using-Fleet/tutorials/Ask-questions-about-your-devices.md
2021-08-12 06:31:34 +09:00
Tomas Touceda
3d8a766ca1
Make receive calls to redis conn thread safe (#1641)
* Make receive calls to redis conn thread safe

Also removes REDIS_TEST env var. Redis is lightweight and fast, no need
to skip these tests.

* No need to increase the wait
2021-08-11 17:34:35 -03:00
Tomas Touceda
ae2bd137b1
Issue 1632 software inventory config (#1636)
* Add config option for software inventory

* Add documentation for the new config
2021-08-11 15:57:53 -03:00
Tomas Touceda
cf6f2152b6
Document vulnerability processing configuration (#1616)
* Document vulnerability processing configuration

* Fix review comments
2021-08-11 13:42:16 -03:00
noahtalerman
63e598e595
API documentation for "filter hosts by team" (#1510) 2021-08-11 11:14:59 -04:00
Tomas Touceda
989e638cc0
Make creating dirs and files more secure by checking permissions (#1566)
* Add safe mkdirall and open

* Use secure as much as possible and merge gomodules for orbit to fleet

* Improve openfile and mkdirall to check for permissiveness instead of equality

* Don't shift

* Fix links

* Address review comments
2021-08-11 11:02:22 -03:00
Mike Thomas
41e8ab271c
Update Ask-questions-about-your-devices.md (#1575)
Checked and fixed a couple of typos here and there, and made some edits to some of the sentence structure to improve the flow, and to soften the tone a bit.
2021-08-11 12:15:49 +09:00
Zach Wasserman
6a1b82f52f
Add yarn install to Windows instructions (#1606) 2021-08-09 18:21:42 -07:00
Tomas Touceda
ccd52985ac
Add Team Schedule documentation (#1576)
* Add Team Schedule documentation

* Update docs/1-Using-Fleet/3-REST-API.md

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>

Co-authored-by: noahtalerman <47070608+noahtalerman@users.noreply.github.com>
2021-08-06 11:19:20 -03:00
noahtalerman
d5974aad97
Add valid time units to Configuration documentation (#1548)
- Specify valid time units of `s`, `m`, and `h` for the `session_duration`, `osquery_label_update_interval`, and `osquery_detail_update_interval` configuration options.
2021-08-04 12:31:24 -04:00
noahtalerman
dea00479d7
Add "Asking questions about your devices" tutorial to "Using Fleet" documentation (#1530)
This tutorial is the first step at bridging the gaps between trying Fleet, getting to know Fleet in an enterprise setting, and deploying Fleet.

- Add "tutorials" subdirectory 
- Add walkthrough
- Remove duplicate documentation from "Fleet UI" section
- Link to walkthrough from top-level README
2021-08-03 11:22:42 -04:00
noahtalerman
741cfb6a58
Add /activities API route to API documentation (#1529) 2021-08-02 13:49:51 -04:00
Tomas Touceda
da46ecc002
Update FAQs based on lessons learned (#1495)
* Update FAQs based on lessons learned

* Update docs/2-Deploying/FAQ.md

Co-authored-by: Zach Wasserman <zach@fleetdm.com>

Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-07-28 19:30:03 -03:00
noahtalerman
da7925e1d7
Remove changes files. Update release process. Update support process (#1492)
- Remove changes files that were collected during the 4.1.0 release cycle
- Add removing changes files step to release process documentation
- Update support process docs to reflect the change to discussing the last on-call rotation at 🍽️  Daily standup meeting
2021-07-27 17:06:16 -04:00
Mike McNeil
7a9d530938
fix copy/paste mistake in docs (#1487) 2021-07-27 11:17:04 -05:00
AndrewB
1decb2a56f
Add "Find deleted files from disk" to Standard query library (#1481) 2021-07-27 09:33:33 -04:00
noahtalerman
3478e2759d
Add the query that populates the 'Users' table in the Fleet UI to the standard query library (#1453)
- The included query populates the `users` property in the `/api/v1/fleet/hosts/{id}` response object.
- This information also populates the new "Users" table on the Host details page
2021-07-26 09:54:50 -04:00
Mike Thomas
27303765cf
Update FAQ.md (#1462)
fixed a small grammatical error.
2021-07-23 21:33:52 +09:00
Mike McNeil
200bc0c036
revert 39d55bf66a 2021-07-22 02:23:42 -05:00
Mike McNeil
39d55bf66a
Test emoji compilation 2021-07-22 02:21:58 -05:00
Benjamin Edwards
799243ffb5
Windows friendly changes after walking through getting started guide (#1441)
* update .gitattributes to be explicit about line endings with regards to the test certs
* update building-fleet guide to include python2 dependency on windows
* update configuration to default to OS specific temporary directories
2021-07-21 20:49:44 -04:00
Tomas Touceda
484c6153e3
Issue 1359 fleetctl team transfer (#1413)
* wip

* Add delete user command and translator

* Add host transfer command

* Add changes file

* Undo bad refactor

* Fix copypaste error

* Implement with interfaces instead of assertions

* Ad documentation and simplify implementation further

* Update docs/1-Using-Fleet/3-REST-API.md

Co-authored-by: Zach Wasserman <zach@fleetdm.com>

Co-authored-by: Zach Wasserman <zach@fleetdm.com>
2021-07-21 14:03:10 -03:00
noahtalerman
00ea74ed80
Add YARA configuration to documentation (#1428)
- Add example YARA config to the configuration-files documentation
- Update `single-file-configuration.yml`
2021-07-21 10:04:50 -04:00
noahtalerman
285d1e66ca
Remove duplicate sections from REST API documentation (#1427)
- Remove duplicate "Transfer hosts to a team" and "Transfer hosts to a team by filter" sections
2021-07-20 09:57:14 -04:00
noahtalerman
7caedd9347
Add routes for Schedule feature to REST API documentation (#1401)
Add documentation (route, parameters, example) for the following routes:
- `GET /api/v1/fleet/global/schedule`
- `POST /api/v1/fleet/global/schedule`
- `PATCH /api/v1/fleet/global/schedule/{id}`
- `DELETE /api/v1/fleet/global/schedule/{id}`
2021-07-19 09:58:41 -04: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
noahtalerman
2c277ba28a
Update documentation for auto table construction (#1353)
- Move auto table construction (ATC) docs into the "Organization settings" section.
2021-07-12 10:36:49 -04:00
gillespi314
099b26724e
Update 2-Testing.md
Correct commands for launching Cypress tests in interactive mode
2021-07-11 10:51:05 -05:00
Tomas Touceda
587f6166a8
Add changes files doc (#1311)
* Describe changes files

* Minor fixes
2021-07-06 18:50:42 -03:00