mirror of
https://github.com/gravitational/teleport
synced 2024-10-21 09:44:51 +00:00
7a8d6f75e5
Added a warning section on importance of identical configs for HA configuration - Closes #1135 |
||
---|---|---|
.. | ||
1.3 | ||
2.0 | ||
2.3 | ||
theme | ||
1.3.yaml | ||
2.0.yaml | ||
2.3.yaml | ||
build.sh | ||
index.html | ||
README.md | ||
run.sh |
Teleport Docs
Teleport docs are built using mkdocs and hosted as a bunch of static files in S3.
Look at build.sh
script to see how it works.
To Publish New Version
- Update build.sh.
- Update index.html to redirect to the latest version automatically.
- Create a new YAML file, like
5.5.1.yaml
if you are releasing version 5.5.1
Deploying
Teleport docs are published using a private web
repository.
See web/README.md
for more info.
Running Locally
To run the latest version of the docs on http://127.0.0.1:8000:
$ ./serve.sh
To run a specific version of the docs:
$ mkdocs serve --config-file 1.3.yaml