179 Commits

Author SHA1 Message Date
Steven Martin eb3e595880 Update running teleport on docker link in readme (#63423) 2026-02-03 17:35:24 +00:00
Adam Pickering e451506be8 Fix broken table of contents link (#63308)
This PR:
- Fixes the [Table of Contents](https://github.com/gravitational/teleport?tab=readme-ov-file#table-of-contents) link for the [Installing and Running](https://github.com/gravitational/teleport?tab=readme-ov-file#installing-and-running) section of the readme. Currently, clicking on it leads nowhere.
-  Changes the wording of the the Supporting & Contributing section to Supporting and Contributing, for consistency. The Table of Contents link to this section is also updated.
2026-02-02 17:16:09 +00:00
Travis Swientek 863c4054f2 Proposed README Updates (#62102)
* first commit

* README Improvements

- Small verbiage improvements throughout
- Adds Editions & Features table
- Adds FAQ

* Formatting Adjustment.

- Formats to 80 character line lengths to improve readability in terminals.

* Update README.md

TOC + punctuation edits

* Addressed feedback.

* Clean up FAQ section, per recommendations.

* Refactored Support & Contributing section.

---------

Co-authored-by: Yovan Grbovic <yovangrbovic@Yovans-MacBook-Pro.local>
Co-authored-by: jack <jackson.pitts@goteleport.com>
2026-01-08 16:27:13 +00:00
Zac Bergquist 57ea14be8b Fix make build-binaries (#62626)
* Fix make build-binaries

The dockerized build (make -C build.assets build-binaries) fails
with GLIBC errors because it is a multi-stage build that runs
across several different containers.

First, we build the webassets in buildbox-node. Then we build the
Teleport binaries in buildbox-centos7, reusing the webassets built
previously.

The issue arises because buildbox-node runs a newer version of GLIBC
than buildbox-centos7, and we weren't properly cleaning some build
artifacts when switching from one builder to another. As a result,
the centos7 builder would see intermediate artifacts with a dependency
on a GLIBC version that is too new.

Fix the issue by ensuring we run a clean-build after hopping into
the centos7 container.

Closes #62594

* Fix build-enterprise-binaries too
2026-01-07 02:38:18 +00:00
rosstimothy b815f5bda1 Update Teleport release support policy (#60885)
The documentation has been updated to reflect the changes
described in [RFD 225](https://github.com/gravitational/teleport/blob/7db03820cec8dcc5a58cff83eb61b42adaef3106/rfd/0225-teleport-extended-support.md).
2025-11-05 18:40:29 +00:00
Noah Stride 0b000b6d28 Remove DevBox (#59455) 2025-09-23 07:49:19 +00:00
rhammonds-teleport 09f6f6c7f7 Remove 'wasm-pack' Build Dependency (#58618)
* Get a Teleport build working without wasm-pack

* * seed docker images with wasm-opt, and wasm-bindgen-cli
* Replace potentially confusing 'CARGO_TARGET_wasm' variable.
* Replace oneoff .gitignore with a corresponding entry in the top level .gitignore.
* Replace 'printf' used to create package.json file with a cleaner multiline string.
* Remove unnecessary 'NEED_VERSION'
* Use awk to find wasm-bindgen version without using 'cargo' since it doesn't seem to be available on ARM64 runners

* Move 'WASM_BINDGEN_VERSION' definition out of versions.mk

* Pass '--locked' flag to wasm-opt install
2025-09-16 17:01:43 +00:00
Chris Thach 6fa24fc591 Improve development environment setup instructions 👨🏾‍💻 ✍🏾 📜 (#57727)
* docs: update instructions for local build dependencies to improve clarity

* docs: use homebrew as primary dependency installer and simplify MacOS env setup

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* docs: improve consistency

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* docs: revert changes to further simplify changes

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* docs: use versions.mk as source of truth

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* docs: add missing replace instruction

* docs: simplify Go install

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* docs: replace protobuf with buf

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* docs: simplify by making all deps required for dev environment

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* docs: add testing instructions for MacOS environment setup

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* refactor: rely on Make to install deps

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* docs: remove pnpm from root README as its no longer needed to be explicitly installed

* refactor: install buf version in versions.mk

Signed-off-by: Chris Thach <chris.thach@goteleport.com>

* fix: bad link for binaryen

---------

Signed-off-by: Chris Thach <chris.thach@goteleport.com>
2025-08-12 22:32:52 +00:00
Paul Gottschling a7c297afe6 Update architecture link in the README (#54921)
Closes #54912
2025-05-19 15:40:24 +00:00
Steven Martin f926efb439 fix db access doc link in README (#51590) 2025-01-29 14:13:52 +00:00
Paul Gottschling 70d70a2d60 Fix outdated docs URLs (#50923)
- Web UI source
- README
- lib
- api

Do not touch docs URLs in test case names or test data where we don't
expect users to navigate to the URLs.
2025-01-16 18:17:35 +00:00
Zac Bergquist de8133d66d Move LICENSE-community out of the root directory (#49266)
Some users are confused that Teleport OSS has been discontinued,
whic is not the case. Additionally, GitHub sees the community edition
license at the root of the repo and displays "Unkown licenses found"
on the repo homepage.

Move the community edition license into build.assets where the packaging
scripts live.
2024-11-27 16:39:28 +00:00
Paul Gottschling 3c5264b3f0 Fix inaccurate docs URLs (#49001)
Closes #48788

Fix docs URLs in `gravitational/teleport` pages that correspond to
neither:
- A redirect source on the default version of the docs site
- A page on the current version of the docs site

In `web/packages/teleport/src/Discover/SelectResource/databases.tsx`,
use literal strings instead of templated strings for docs URLs so we can
check these URLs for inaccuracies.
2024-11-14 20:07:40 +00:00
Steven Martin 335812d230 Update README.md (#48789) 2024-11-13 13:15:47 +00:00
Steven Martin a95a30d3fe Update README.md to remove reference to webassets sub module (#47736)
* Update README.md to remove reference to webassets sub module

* update web ui desc in readme

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

---------

Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
2024-10-21 08:19:18 +00:00
Alan Parra dc3052b0c7 Reword tsh Touch ID build instructions (#47472) 2024-10-11 13:47:54 +00:00
Paul Gottschling 838f49d35d Update links in the README (#45336) 2024-08-09 20:42:04 +00:00
Zac Bergquist fa64296694 Update image assets with new logos (#44525) 2024-07-22 22:30:58 +00:00
Steven Martin 9cffa177ac remove docker link from README (#44491) 2024-07-22 10:32:17 +00:00
Grzegorz Zdunek 620c0a0f9b Switch JS package manager to pnpm (#44167)
* Adjust `package.json`s to pnpm

* Convert resolutions (pnpm doesn't support `**/` syntax)

It also removes resolutions that are no longer relevant.

* Convert `yarn.lock` to `pnpm-lock.yaml` with `pnpm import`

* Always add `e/web/teleport` workspace to the lockfile

* Adjust `jest` to new node_modules structure

* Adjust `storybook` to new node_modules structure

* Replace `toHaveStyleRule` with `toHaveStyle`

`jest-styled-components` package is no longer global, so `toHaveStyleRule` matchers is not recognized by TS.
We use them only in three places, so it's simpler to convert them to `toHaveStyle`.

* Adjust README files

* Adjust GHA workflows

* Adjust build assets

* Remove remaining `yarn` mentions

I don't think anyone uses the debug configuration for electron (and we don't have `start-electron` script for a long time).

* `corepack enable` -> `corepack enable pnpm`

* Automatically enable pnpm when running `make build/teleport`

* Run `pnpm import` again

* Run `pnpm dedupe`

* Add `yarn.lock` to .gitignore

* Link to pnpm installation docs

* Add a better comment for `transformIgnorePatterns`

* Make pattern for `shared` stories more specific

* Change `corepack enable pnpm` in readmes

* Run `pnpm import && pnpm dedupe` again
2024-07-19 09:53:32 +00:00
Alan Parra deac28ff90 Document recent libfido2 Makefile changes (#43296) 2024-06-20 17:01:48 +00:00
Zac Bergquist 1d0c382a2f Add community edition license for Teleport 16+ (#41054)
See https://goteleport.com/blog/teleport-community-license/
for details of this announcement.
2024-05-03 14:51:57 +00:00
Paul Gottschling d9e96864b6 Remove the Teleport Team mention from the README (#39038) 2024-03-07 14:24:52 +00:00
Isaiah Becker-Mayer 9afd175125 Adds info about rust, wasm-pack, and binaryen to relevant readmes (#37055)
* Adds info about rust, wasm-pack, and binaryen to relevant readme's

* CR

* Capitalizing Linux

* formatting

* Accurately identifies when wasm-opt need be installed manually

https://github.com/rustwasm/wasm-pack/blob/bdc4884fc5dcb50d78e521acfb2f613fb6588b48/src/install/mod.rs#L175-L183
is the internal wasm-pack code that checks for wasm-opt and installs it automatically if it's not found, but
only for certain os/arch combinations.
2024-02-22 10:00:03 +00:00
Zac Bergquist aefff57a1e Update README.md (#38119)
1. Fixing typos.
2. Improving the Readme.md

Signed-off-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: kakashi2508 <131848180+kakashi2508@users.noreply.github.com>
2024-02-13 14:50:09 +00:00
Cam Hutchison ca6ba775ea Update master post-branch/v15 (#36688)
Update master as the now-source of v16 when it gets cut:
* Update `VERSION` in `Makefile` to 16.0.0-dev
* Update `BUILDBOX_VERSION` in `build.assets/Makefile` to `teleport16`
* Update a couple of mentions of v13 in `README.md` to v16
* Run `make update-version`
* Run `make dronegen`

Some workflows are to be updated once v15.0.0 is actually released.
2024-01-15 10:07:43 +00:00
Taras dfe7679a25 Update MacOS build instructions (#36509)
- Install pkg-config
- Use openssl@3
2024-01-10 18:13:26 +00:00
Bartosz Leper c57cc63763 Support running Teleport in a "hot reload" mode (#35040)
This change follows the example of our Cloud project which uses the same solution under the hood.
2024-01-04 11:14:00 +00:00
Zac Bergquist def0737cae README: update to AGPL 3.0 (#35270)
Replace the badge and link from Apache 2.0 to AGPL 3.0
2023-12-01 20:10:03 +00:00
Alexander Klizhentas 7e2cff599e Updates README. (#32456)
Updates hero image, removes happy talk, uses new language
focusing on protection.
2023-09-25 17:01:50 +00:00
Steven Martin 357e1e3698 Docker readme update (#31157) 2023-08-29 17:28:48 +00:00
Zac Bergquist 012c42b68d Fix incorrect link in README (#29519)
Signed-off-by: Zac Bergquist <zac.bergquist@goteleport.com>
Co-authored-by: Kerwin Bryant <kerwin612@qq.com>
2023-07-24 21:23:00 +00:00
Jakub Nyckowski b66ce4fdf3 Remove outdated Updating Web UI assets section from README.md (#27654)
After the merge, this section in our README file is no more relevant.
2023-06-09 16:56:34 +00:00
Michael Wilson 90c98c38fd Initial devbox. (#27373)
* Initial devbox.

As devbox has added in version pinning, it seems like a viable way for
maintaining consistent tooling across devboxes. This is an initial pass
at using devbox in Teleport.

* Use latest git/bash, use clang instead of gcc.

* Add in TELEPORT_DEVBOX env variable for future use.

* Alphabetize and add in gotestsum.

* Remove gotestsum.

* Bump golangci-lint to 1.53.2

* Make sure libbpf works in linux.

* Add in notes to update devbox.json, add in a few more dependencies to devbox.json.

* Remove extraneous comments in Dockerfile, add in README.md blurb.
2023-06-08 16:03:39 +00:00
Ben Arent 46768ac63e bump version numbers in Readme (#26387) 2023-06-06 21:10:59 +00:00
Paul Gottschling af0d583a64 Update the README to mention Teleport Team (#26699)
* Update the README to mention Teleport Team

Mention Teleport Team in the section related to installing and running
Teleport. Also replace the current instructions with a link to the
Getting Started guide, which contains up-to-date information.

* Remove out-of-date links

Responding to stevenGravy feedback.
2023-05-22 21:21:28 +00:00
Jonathan Lassoff 48d91ab84d Update setup docs to include Yarn (#21055)
Include references to install Yarn for building the UI, as well as the
alternative "docker-ui" make target.

The Yarn install process is currently dependent on yarn 1.x / pre-2.0
2023-02-10 00:13:48 +00:00
Jonathan Lassoff 42a7be6058 Update security information in docs. (#21054)
* Update security information in docs.

Update README.md with some updated security and trust information.

Additonally, update SECURITY.md to deprecate our email-based submission process
with our current process via HackerOne.
This change also removes the now-unused PGP public key document.

* Update README.md

Co-authored-by: Reed Loden <reed@goteleport.com>

* Update Teleport download link to current page.

---------

Co-authored-by: Reed Loden <reed@goteleport.com>
2023-02-01 02:37:16 +00:00
Rafał Cieślak b94edcf450 Move tsconfig.json to root dir, remove web Makefile and Dockerfile (#20399)
* Move tsconfig.json to root dir

At the moment, it looks like the TS language server has problems with
recognizing imports when editing files inside e/web.

I figured this is probably because tsconfig.json is in web, so the lang
server doesn't recognize it when editing files from e/web.

* Remove web/Dockerfile and web/Makefile

* Misc updates to readme

* Fix links in readme
2023-01-23 11:50:16 +00:00
Alexander Klizhentas 10a8adb0bb Update README hero image (#18411)
Update README.md hero image and links
2022-11-14 16:35:10 +00:00
Avirup Some 75941cfb3b Found a grammatical error in Line no. 338 (#16131) 2022-10-14 19:32:29 +00:00
Steven Martin 87a80da26c spell fixes (#17374) 2022-10-13 15:34:19 +00:00
Xin Ding 8ca3cc20a5 Change the README.md header image temporarily to promote Teleport's user conference (#17016) 2022-10-08 05:08:35 +00:00
Logan Davis 830794a9cf Replace quay.io with amazon ECR where appropriate (#15382) 2022-08-19 10:24:15 -05:00
Dima Ilchenko f3c817dc24 Update teleport build instructions (#15092)
Update teleport build and dependencies setup instructions

 * add notes about libfido and how to build tsh with it
 * add detailed instructions about installing Go and Rust
 * restructure/reformat the Local Build section
 * add a note about TouchID support for tsh
 * add instructions for test dependencies
 * link to test dependencies from testing section of the README.md
 * git submodule update note
 * remove $ from shell command snippets

Co-authored-by: Alan Parra <alan.parra@goteleport.com>
2022-08-04 19:08:02 -04:00
Zac Bergquist 61463166c1 Remove tctl roletester (#13863)
This code was unmaintained, created issues with our build system,
and didn't actually match the behavior of Teleport's RBAC engine.

We will revisit this functionality in the future when we investigate
"acess policies as code."
2022-06-25 04:01:21 +00:00
Ryan Clark 0f6b858833 Fix the link to the webapps README.md (#13733) 2022-06-23 10:35:03 +00:00
Steven Martin b6e7865e66 Add notes that master is a development branch in readme build instructions (#12310) 2022-05-12 23:45:36 +00:00
Zac Bergquist 9a1c0f6f92 Fix broken FAQ link in README (#12552)
Closes #12534
2022-05-10 18:05:01 +00:00
STeve (Xin) Huang a9267d8ca7 Fix broken header img and update badge in Readme (#11395) 2022-03-23 23:57:09 +00:00