Commit Graph
50 Commits
Author SHA1 Message Date
Alex McGrath 65459e872e Remove support for disabling second factor authentication (#40956)
* dont allow disabling second factor

* update docs for 2fa change

* add environmental variable to work around disabled 2fa

* check if its cloud

* update todos

* add a test

* introduce insecure test mode

* fixes for tests
2024-05-10 11:57:34 +00:00
STeve (Xin) Huang 978106414f [docs] Update DB access AWS IAM reference page (#38881)
* [docs] Update DB access AWS IAM reference page

* add other aws databases

* reword and fix a few spots

* remove please and add the for service

* address review coments

* fix spelling

* fix link
2024-05-06 18:04:31 +00:00
Roman Tkachenko 65d05fd28b Remove standalone Okta service docs (#40799) 2024-04-23 15:27:27 +00:00
Paul Schisa aa3dce856d Update docs to call out acme is not for HA (#39697)
* Update docs to call out acme is not for HA

based on user issues, until https://github.com/gravitational/teleport/issues/27613#issue-1746989232 is implemented we should call out that using ACME is not for HA deployments

* Update proxy-service.yaml
2024-04-11 15:12:24 +00:00
Hugo ShakaandPaul Gottschling ebb9705b42 Simplify the selfhosted AU guide (#40054)
* Simplify the selfhosted AU guide

* update proxy config reference

* typo

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* address feedback

* address feedback pt.2

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* fix broken link

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2024-04-09 21:37:00 +00:00
Marek Smoliński d25acdb341 docs: Access Monitoring IaC selfhosted setup (#40223)
* docs: Access Monitoring IaC selfhosted setup

* update
2024-04-09 11:58:22 +00:00
Paul Gottschling 0fcb04e7c1 Remove auto-discovery from specific DB guides (#39030)
* Remove auto-discovery from specific DB guides

Closes #22942

Help users enroll specific databases with Teleport while directing them
auto-discovery instructions if they want to go that route.

- Revert #30913 for guides to enrolling specific databases. For guides
  that always included auto-discovery instructions, add instructions to
  enroll databases at specific URLs.
- Add a note in the introduction sections of AWS guides that it is
  possible to enroll AWS databases with auto-discovery, linking to the
  relevant guide.

* Respond to greedy52 feedback

- Remove auto-discovery notes where they are incorrect.
- Remove unneeded `id` flags.
- Use `teleport db configure create` for Redshift Serverless, removing
  unneeded config fields. Also add the `aws-bootstrap.mdx` partial to
  the Redshift Serverless guide, making it more consistent with other
  guides that include `teleport db configure bootstrap` instructions.
- Minor spelling/grammar tweaks.
- Fix example description outputs.
- Use URI/protocol flags in `rds-proxy.mdx` instructions.
- Restore `opensearch` to `database-config.yaml`.

* Respond to greedy52 feedback

- Add the `--name` parameter to `db configure create`
- Edit `tsh db ls` output in the RDS guide

* Fix linter issues
2024-04-08 18:27:39 +00:00
Gabriel Corado 775391bbbf Document server access enhanced recording option root_path (#38399)
* docs(server-access): add root_path option

* docs(bpf-recording): add a section about `root_path` option

* docs(enhanced-recording): update naming for session resources

* docs: fix lint error

* fix(cspell): add missing word
2024-04-01 19:20:36 +00:00
Alan Parra 284340a06f Document Jamf page_size parameter (#39927) 2024-04-01 15:31:30 +00:00
Przemko RobakowskiandZac Bergquist 6259164732 Update docs for static_hosts in Windows Desktop configuration (#35805)
* Update docs for static hosts in Desktop

* Update docs/pages/desktop-access/getting-started.mdx

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* Update docs/pages/desktop-access/getting-started.mdx

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* review comment

* e

* review comment

* review comment

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-12-18 22:21:22 +00:00
STeve (Xin) Huang 7f3c58df1f Add default database support for PostgreSQL Auto-user provisioning (#34420)
* Added "defaultDatabase" support for Postgres auto-user provisioning

* update doc
2023-11-15 15:26:10 +00:00
rosstimothyandMusaed Albrikan 96133038d3 Fix discrepancies with dynamo events retention period (#33998)
* Replace audit_retention_period with retention_period

* Override a zero retention period with the default value

* Update docs to reflect which backends respect the retention_period

* Remove unused json tags from dynamo events config

---------

Co-authored-by: Musaed Albrikan <mabrikan@gmail.com>
2023-10-27 20:51:38 +00:00
Zac Bergquist 8388004aca docs: improve formatting of bool options (#33658)
We should not use `[true|false]` syntax when describing fields
in a YAML file, as the square brackets may be interpreted as a
YAML list instead of a scalar boolean value.
2023-10-20 18:59:04 +00:00
Steven Martin 71da63ab94 docs: include all db protocols in faq and config (#33495) 2023-10-18 15:20:32 +00:00
Zac Bergquist 3afd112bb7 docs: mention support for multiple AD domains (#33273)
This documents the changes in #33218
2023-10-11 20:41:30 +00:00
lsgunn-teleport b90107f38e docs: change open source/OSS references to community edition (#32771)
* Change Open source and OSS to Teleport Community Edition

* Change open-source to Teleport Community Edition

* Role access requests in the nav and title
2023-09-29 22:06:45 +00:00
Anton Miniailo 31de09a02c Fix usage of ClusterName from config when starting Auth server (#32624) 2023-09-27 17:42:51 +00:00
lsgunn-teleport 9c1fd94f69 Remove reference to use a load balancer (#32596) 2023-09-26 22:49:24 +00:00
Alex McGrath 23abd1d615 Allow including only traits when doing a JWT rewrite (#32193) 2023-09-21 11:54:54 +00:00
Anton MiniailoandZac Bergquist 5a0b158219 Update config reference for proxy_protocol field. (#32259)
* Update config reference for proxy_protocol field.

* Improve wording.

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* Copy tweaked description to proxy_service

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-09-20 20:35:51 +00:00
STeve (Xin) Huang 8fed26b607 [docs] AWS database discovery (#30913)
* [docs] AWS database discovery

* try to fix spell

* remove tctl/terraform from guides

* update next steps

* fix link

* fix discovery token

* remove register step

* try to fix lint

* another review comments round

* merge create db configuration tabs

* use simple sudo teleport db configure create

* fix opensearch next steps

* review comments from Isgunn
2023-09-15 18:36:48 +00:00
lsgunn-teleport cdc2a3c2af Change general links to point to the Desktop intro instead of the non-AD config section (#31675) 2023-09-13 18:35:34 +00:00
Russell Jones 8078a8bea7 Clarified default cryptographic primitives (#31128) 2023-08-30 02:11:06 +00:00
Forrest 4e66a6fc67 support case-insensitive routing option (#29320)
* support case-insensitive routing option

* update docs
2023-08-17 00:48:19 +00:00
Alex McGrath a01417a854 Document jwt_claims app rewrite option (#30256)
* Document `jwt_claims` app rewrite option

* resolve comments

* Update JWT section and untabify
2023-08-11 15:24:26 +00:00
Justinas Stankevičius b52ab6c7ac Adjust indentation in Assist YAML conf reference (#29195) 2023-07-24 21:54:30 +00:00
Gavin Frazar 4f6e9949df update config reference docs (#29226) 2023-07-17 23:11:15 +00:00
Justinas Stankevičius a68f58426c Add assist fields to configuration reference (#29052) 2023-07-14 10:33:13 +00:00
STeve (Xin) Huang e2f3695e48 [docs] add proxy_service.trust_x_forwarded_for option (#28461)
* [docs] add proxy_service.trust_x_forwarded_for option

* review comments

* add not for single ip
2023-07-13 17:13:29 +00:00
STeve (Xin) Huang fa0c42ebcc [doc] database labels reference (#28825)
* [doc] database labels reference

* Alex's comments
2023-07-13 17:06:58 +00:00
Paul Gottschling b036fa0dd4 Add more details about specifying a CA pin (#27731)
* Add more details about specifying a CA pin

Closes #9946

The CA pin is the only Teleport configuration field where we have not
yet documented the possibility of specifying a value using a file path.
This change includes this information, as well as the (also
undocumented) fact that you can specify a list of CA pins. Also updates
the docs path that the CA pin reference links to.

* Respond to zmb3 feedback

* Respond to lsgunn-teleport feedback
2023-07-10 13:04:32 +00:00
Paul Schisa 0062b2feb5 Update keep_alive comments auth-service.yaml (#28813)
based on conversations internally, adding more clarity around keep alive to indicate it affects reverse tunnel connections as well

https://github.com/gravitational/teleport/blob/4e3c3bb728d656b3b628fa4563e4143fb59383d7/lib/reversetunnel/agentpool.go#L744
2023-07-07 14:50:23 +00:00
Anton MiniailoandPaul Gottschling 0f60bf2846 [Docs] Add missing 'resources' config field to application service docs (#28753)
* Add missing 'resources' config field to application service docs

* Update docs/pages/includes/config-reference/app-service.yaml

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Improve dynamic apps description

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-07-07 08:07:07 +00:00
Alan Parra c3d39a99d9 Document Jamf exit_on_sync toggle (#28394) 2023-06-27 22:29:09 +00:00
Alan ParraandAlex Fornuto 89e4d7381a Document Jamf service and auto-enroll (#28167)
* Use teleport.example.com as the example proxy

* Add the core Jamf guide steps

* Add sync schedule optional section

* Add the multiple sources optional section

* Add the auto-enrollment guide

* Add the Jamf service reference config

* Add words to cspell.json and sort it

* Use `--config` instead of `-c`

* Apply Alex's suggestions

* Add preview admonition to auto-enrollment.mdx
* Add scopes for auto-enrollment guide
* Add scopes for jamf-integration guide
* Remove "and restart" from Auth update instructions
* Auth restart instructions
* s/Jamf service/The Teleport Jamf service/
* Use an inline code block for external links
* s/the following/the following keys/
* Use inline code block for key names
* Use inline code block for key names
* Use inline code block for key names
* Use inline code block for key names
* Mention "local workstation" after we transition from Jamf to Teleport
* Mention Jamf service host when switching context
* Use `(=presets.tokens.second=)`
* Use `(=presets.ca_pin=)`
* Mention logs example explicitly
* Add a missing comma

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Address Alex's comments

* Reflow text
* Remove redudant tsh prereqs sentence
* Add a registered device to auto-enrollment prereqs
* Use headers instead of bold

* Use a narrower image for jamf-setup-2.png

---------

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-06-27 19:54:19 +00:00
Alex McGrath 0760bc9776 Allow setting max_session_ttl from clusterauth preferences (#26824)
Document `default_session_ttl` in the reference.
2023-06-21 10:39:34 +00:00
Isaiah Becker-Mayer 38486e158b Primarily changes "match: '^.*\.dev\.example\.com$'" to "match: '^.*\.dev\.example\.com'" so that users aren't mistakenly guided towards eliminating the implicit ":3389" from their regex matches (#27423) 2023-06-07 02:02:34 +00:00
Zac Bergquist 705694e28d docs: add missing server_name to LDAP config (#26598) 2023-05-22 15:28:52 +00:00
Michael WilsonandRoman Tkachenko 68d4c4a679 Okta documentation. (#25580)
* Okta documentation.

Okta documentation has been added for the Okta service. This aims to explain
the Okta service and give simple examples.

* Typo fixes, comment fixes, naming fixes.

* Reorganization of Okta docs, fixing typos, adding in images and tuning wording.

* Use an architecture image for now until mermaid support can be reenabled.

* Correct spellings.

* Update docs/pages/application-access/okta/guide.mdx

Co-authored-by: Roman Tkachenko <roman@goteleport.com>

* Correct architecture diagram.

* Linting fixes.

---------

Co-authored-by: Roman Tkachenko <roman@goteleport.com>
2023-05-09 17:58:02 +00:00
Gavin FrazarandPaul Gottschling a073f51f9d add assume_role_arn and external_id docs reference (#25244)
* add assume_role_arn and external_id docs reference

* Update docs/pages/includes/config-reference/database-config.yaml

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Update docs/pages/includes/config-reference/database-config.yaml

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Update docs/pages/database-access/reference/configuration.mdx

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Update docs/pages/database-access/reference/configuration.mdx

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Update docs/pages/includes/config-reference/database-config.yaml

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-04-28 17:48:41 +00:00
Hugo ShakaandPaul Gottschling aff81fece2 docs: kubernetes joining guide + reference (#20298)
* docs: kubernetes joining guide + reference

* fixup! docs: kubernetes joining guide + reference

* Address most feedback

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Update docs/pages/management/guides/joining-services-kubernetes-serviceaccount.mdx

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

* Explain what the join method does

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-04-13 15:42:54 +00:00
Paul Gottschling 1ee16dda12 Tweak messaging to anticipate a new linter (#22270)
In gravitational/docs#238, we will add a linter that lints for incorrect
usage of Teleport terms. This change fixes linter violations to
anticipate this new linter.

Changes include:

- Ensuring that Teleport service names are capitalized
- No longer using the "[Resource] Access" terminology. Instead, talk
  about adding resources, using Teleport services, etc.
2023-04-11 16:42:00 +00:00
Alex Fornuto 2f31c7479c purge extra newlines (#24247) 2023-04-07 16:03:01 +00:00
Brian JoergerandZac Bergquist aaeb2b2c33 Headless Authn: documentation (#23272)
* Add docs.

* Update docs/pages/access-controls/guides/headless-login.mdx

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>

* Fix lint error.

* Ellaborate on how headless login differs from standard login.

* Resolve comments; Fix capitalization.

* Resolves comments.

* Add cli reference docs.

* Restructure guide; Remove scoped blocks; Update descriptions; resolve other comments.

* Make configuration options/alternatives collapsible; Fix typos.

* Fix file names, titles, and make new config details begin as closed.

* Fix hidden merge conflict.

* Add line breaks.

* Fix dead link.

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2023-04-03 16:34:38 +00:00
Michael 50374f7f16 [docs] Change scrollback_length to scrollback_lines (#23706) 2023-03-28 18:46:01 +00:00
Michael 537899e52a Change proxy_service ui_config to ui (#23668) 2023-03-27 21:31:26 +00:00
Steven Martin e0c1346730 Desktop Listen Address Config Change (#23622)
The desktop listen address is for the proxy to be able to connect. If it's set to localhost/127.0.0.01 then a Proxy can't reach it.  This makes it more in-line with SSH listener.
2023-03-27 19:35:44 +00:00
MichaelandPaul Gottschling 6c58a9ecd9 [docs] Add documentation for static and dynamic ui_config (#22736)
* [docs] Add documentation for static and dynamic ui_config

* Fix indentation

* Add newline

* Apply suggestions from code review

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>

---------

Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
2023-03-07 23:31:58 +00:00
Michael Wilsonandalexfornuto 48daeff5bd SAML identity provider docs. (#22414)
* SAML identity provider docs.

SAML IdP documentation has been added.

* formatting

* spelling

* Zac's and Roman's feedback.

* Valid config.json.

* Linting updates.

* usr Var component

Adding as a unique commit in case it's not desired

* align output with object name

* Roman's feedback, add in a section for disabling the IdP.

* copy edits

* SAML Grafana guide (#22545)

* init Grafana SAML guide

* respond to review feedback

* Correct entity provider to identity provider.

* Note that HSM is not currently supported.

* Fix link.

---------

Co-authored-by: alexfornuto <alex.fornuto@goteleport.com>
2023-03-04 00:29:52 +00:00
Paul GottschlingandAlex Fornuto da0e53ecdb Reorganize the config reference (#21594)
* Reorganize the config reference

Closes #11253

This change breaks up the config reference by moving each Teleport
service's configuration settings into a separate YAML snippet, and
organizing each YAML snippet into a `TabItem` within a `Tabs` with
`dropdownView` enabled. When Teleport Enterprise Cloud doesn't support a
service, this change adds a `Notice` with a message about Teleport
Enterprise Cloud in the relevant `TabItem`.

I thought this approach would be cleaner than alternatives:

- **Including an H2 for each service:** With this approach, the
  configuration reference would be even longer than it is now. With the
  approach I'm proposing, readers would navigate to "Reference
  configurations", then choose a service from a dropdown menu: much less
  scrolling for slightly more clicking.

- **Including another set of `TabItem`s for Teleport editions:** I
  thought about adding a `Tabs` with a dropdown option for each Teleport
  edition and a horizontal `TabItem` for each service, but this would
  require horizontal scrolling and doesn't scale very well.

- **Including horizontal tabs for each Teleport edition**, with an inner
  dropdown menu for each Teleport service: There is currently no way to
  do this without multiple `Tabs` components, which gets messy quickly.

**Note** that this change does not attempt to copy-edit comments/example
values within the configuration snippets. The scope of this change is
limited only to reorganization.

* Respond to PR feedback

* Update docs/pages/includes/config-reference/instance-wide.yaml

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>

* Respond to PR feedback

Use headings instead of `TabItem`s to split up sections of the config
reference.

---------

Co-authored-by: Alex Fornuto <alex.fornuto@goteleport.com>
2023-02-24 22:12:38 +00:00