docs.konghq.com
π¦ Archived repo for docs.konghq.com website. Use https://github.com/Kong/developer.konghq.com instead.
File Explorer
Download Latest Version (.zip)- config.yml
- improve-existing-docs.yaml
- improve-site.yaml
- auto-ignore.txt
- dictionary.txt
- kongterms.yml
- Relativeurls.yml
- Repetition.yml
- Spelling.yml
- Terms.yml
- autogenerated-warning.yml
- build-docs-pdf.yml
- build-plugin-pdf.yml
- check-links.yml
- ci-autofix.yml
- dispatch-docs-update.yml
- fetch-konnect-changelog.yml
- generate-changelog.yml
- install-instructions-test.yml
- linting.yml
- push-oas-downstream.yaml
- require-review-label.yml
- run-tests.yml
- scheduled-broken-link-checker.yml
- security.yaml
- send-docs-for-translation.yml
- send-plugins-for-translation.yml
- sync-konnect-oas-data.yml
- sync-kuma-submodule.yml
- sync-submodules.yml
- CODEOWNERS
- PULL_REQUEST_TEMPLATE.md
- raise-pr-on-change.json
- renovate.json
- kong-ee.yaml
- kong-ee-3.3.json
- kong-ee-3.3.yaml
- kong-ee-3.4.json
- kong-ee-3.4.yaml
- overlay.yaml
- kong-ee-3.5.yaml
- kong-ee-3.6.yaml
- kong-ee-3.7.yaml
- kong-ee.yaml
- kong-ee.yaml
- kong-ee.yaml
- portal-api.yaml
- kong-oss-33.json
- kong-oss-33.yaml
- kong-oss-3.4.json
- kong-oss-3.4.yaml
- kong-oss-3.5.yaml
- kong-oss-3.6.yaml
- kong-oss-3.7.yaml
- kong-oss.yaml
- kong-oss.yaml
- kong-oss.yaml
- gateway-status.yaml
- control-planes-config.json
- control-planes-config.yaml
- mesh-control-planes.yaml
- konnect.json
- konnect.yaml
- consumers.yaml
- ksearch.yaml
- analytics-requests.yaml
- api-products.yaml
- application-auth-strategies.yaml
- audit-logs.yaml
- cloud-gateways.yaml
- control-planes.yaml
- overlay.yaml
- portal-management.yaml
- api-builder.yaml
- identity.yaml
- portal-management.yaml
- portal.yaml
- metrics.yaml
- docs.md
- api-description.yaml
- tag-descriptions.yaml
- api-description.yaml
- tag-descriptions.yaml
- portal.yaml
- readme.md
- alias_generator.rb
- _headers
- _redirects
- robots.txt
- data.lua
- parser.lua
- run.lua
- docs_nav_1.4.x.yml.admin-api.in
- docs_nav_1.4.x.yml.head.in
- docs_nav_2.0.x.yml.admin-api.in
- docs_nav_2.0.x.yml.head.in
- docs_nav_2.1.x.yml.admin-api.in
- docs_nav_2.1.x.yml.head.in
- docs_nav_2.2.x.yml.admin-api.in
- docs_nav_2.3.x.yml.head.in
- docs_nav_2.4.x.yml.head.in
- docs_nav_2.5.x.yml.head.in
- run.lua
- jekyll-vite
- vite
- package-lock.json
- package.json
- README.md
- run.js
- en.yml
- vite.json
- generated-files.md
- ruby-debug.md
- _index.yml
- _index.md
- _index.md
- _changelog.md
- versions.yml
- _index.yml
- _index.yml
- _index.md
- _index.json
- _changelog.md
- explanation-template.md
- how-to-template.md
- reference-template.md
- tutorial-template.md
- troubleshoot.md
- autodocs.md
- ci-cd.md
- oas-pages.md
- platform-install.md
- product-releases.md
- search.md
- seo.md
- single-sourced-plugins.md
- single-sourced-versions.md
- testing.md
- vale.md
- build
- mesh_latest_version.js
- .gitkeep
- build-urls.js
- create-pdf.js
- list-plugins.js
- list-versions.js
- package-lock.json
- package.json
- run.js
- package-lock.json
- package.json
- README.md
- run.js
- config_spec.rb
- plugin_example_spec.rb
- curl_spec.rb
- yaml_spec.rb
- badges_spec.rb
- example_spec.rb
- hub_examples_spec.rb
- schema_field_spec.rb
- schema_spec.rb
- sidenav_menu_item_spec.rb
- versions_dropdown_option_spec.rb
- option_spec.rb
- releases_dropdown_spec.rb
- sidenav_spec.rb
- products_renderer_spec.rb
- page_data_spec.rb
- page_url_generator_spec.rb
- product_spec.rb
- nav_items_data_spec.rb
- version_data_spec.rb
- base_spec.rb
- changelog_spec.rb
- configuration_examples_spec.rb
- configuration_spec.rb
- how_to_spec.rb
- overview_spec.rb
- base_spec.rb
- kong_spec.rb
- third_party_spec.rb
- kong_spec.rb
- third_party_spec.rb
- base_spec.rb
- page_data_spec.rb
- release_spec.rb
- releases_generator_spec.rb
- unversioned_spec.rb
- versioned_spec.rb
- single_source_page_spec.rb
- global_page_spec.rb
- hub_html_page_spec.rb
- hub_index_spec.rb
- hub_latest_spec.rb
- hub_not_latest_spec.rb
- unprocessable_page_spec.rb
- unversioned_product_page_spec.rb
- unversioned_product_page_spec_deck.rb
- versioned_page_spec.rb
- title_spec.rb
- index_entry_builder_spec.rb
- index_spec.rb
- sitemap_spec.rb
- canonical_url_spec.rb
- alias_generator_spec.rb
- kuma_to_kong_mesh_spec.rb
- latest_version_generator_spec.rb
- oas_definition_pages_generator_spec.rb
- plugin_single_source_generator_spec.rb
- sitemap_spec.rb
- versions_spec.rb
- table_tag_spec.rb
- _index.md
- _index.md
- _index.md
- docs_nav_deck.yml
- docs_nav_gateway_2.6.x.yml
- docs_nav_gateway_3.0.x.yml
- docs_nav_kic_2.1.x.yml
- docs_nav_kic_2.2.x.yml
- docs_nav_kic_2.7.x.yml
- docs_nav_konnect.yml
- docs_nav_mesh_1.6.x.yml
- docs_nav_mesh_2.0.x.yml
- docs_nav_mesh_2.1.x.yml
- docs_nav_mesh_2.5.x.yml
- docs_nav_mesh_2.6.x.yml
- extensions.yml
- hub_filters.yml
- kong_versions.yml
- konnect_oas_data.json
- _index.md
- _index.yml
- _index.yml
- _local-testing.md
- _index.md
- _index.json
- _index.yml
- _index.md
- _index.json
- _changelog.md
- versions.yml
- _index.yml
- _index.md
- _index.md
- _changelog.md
- versions.yml
- _2.6.x.yml
- _index.yml
- _tutorial-with-min-and-max.md
- _tutorial.md
- _index.md
- _index.md
- _nested.md
- _changelog.md
- versions.yml
- _common_redirects
- index.md
- configuration.md
- index.md
- index.md
- index.md
- index.md
- index.md
- index.md
- index.md
- index.md
- changelog.md
- index.html
- index.md
- index.md
- index.md
- index.md
- index.md
- index.md
- changelog.md
- 404.html
- _includes
- _layouts
- _redirects
- index.md
- kuma-to-kong-mesh.md
- moved_urls.yml
- search.html
- site.rb
- plugin.rb
- configuration_spec.rb
- plugin_spec.rb
- plugin_with_versions_spec.rb
- spec_helper.rb
- customMatchers.js
- fetchPage.js
- breadcrumbs.test.js
- descriptions.test.js
- edit_link.test.js
- home.test.js
- install.test.js
- plugin.test.js
- seo.test.js
- sidebar.test.js
- titles.test.js
- nav-to-index-page.js
- nav-to-urls.js
- src-to-urls.js
- path-to-url.js
- build-site.js
- package-lock.json
- package.json
- README.md
- run.js
- scrape.js
- serve.js
- fetch-beamer-posts.js
- ignored_paths.json
- ignored_targets.json
- check-url-list.js
- full.js
- package-lock.json
- package.json
- README.md
- run.js
- changelog.js
- package-lock.json
- package.json
- package-lock.json
- package.json
- run.js
- expected-failures.yaml
- jobs.yaml
- setup.yaml
- .gitignore
- execute-in-docker.js
- index.js
- instruction-extractor.js
- package-lock.json
- package.json
- README.md
- package-lock.json
- package.json
- README.md
- run.js
- kuma.yml
- mesh.yml
- kuma-to-mesh.js
- kuma-to-mesh.test.js
- mesh-to-kuma.js
- package-lock.json
- package.json
- README.md
- package.json
- README.md
- run.js
- run.sh
- package-lock.json
- package.json
- README.md
- run.js
- kong-manager.yaml
- explorer-dashboard.yaml
- reports.yaml
- summary-dashboard.yaml
- upstream-latency-report.yaml
- api-products-dashboard.yaml
- api-products-manage.yaml
- documentation.yaml
- mesh-manager-dashboard.yaml
- control-plane-dashboard.yaml
- konnect-dashboard.yaml
- service-package-dashboard.yaml
- custom-plugins.yaml
- plugin-list.yaml
- kic.yaml
- runtime-instances-overview.yaml
- overview.yaml
- macros.yaml
- README.md
- markdown-files.js
- supported-versions.js
- supported-versions.js
- yaml-files.js
- batch_params.js
- file_readers.js
- file_uris.js
- rate_limit.js
- yaml-files.test.js
- config.yml
- download.js
- package-lock.json
- package.json
- test-integration.js
- upload_docs.js
- upload_plugins.js
- .editorconfig
- .env.example
- .git-blame-ignore-revs
- .gitattributes
- .gitignore
- .gitmodules
- .node-version
- .prettierignore
- .prettierrc.json
- .rspec
- .rubocop.yml
- .ruby-version
- .vale.ini
- changelog.md
- CODE_OF_CONDUCT.md
- docker-compose.yml
- entrypoint.sh
- Gemfile
- Gemfile.lock
- include-check.sh
- jekyll-dev.yml
- jekyll.yml
- LICENSE
- Makefile
- netlify.toml
- package-lock.json
- package.json
- playwright.config.js
- Procfile
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/Kong/docs.konghq.com
Downloads the entire project code from GitHub to your computer.
cd docs.konghq.com
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Node.js
EasyPrerequisites
cd check-generated-content
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
4. Ruby
EasyPrerequisites
bundle install
Installs the Ruby libraries listed in the Gemfile.
If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
5. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make install
Compiles the code based on the generated build configuration to produce an executable.
make run
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)