kong

(★ 44,016)

🦍 The API and AI Gateway

File Explorer

Download Latest Version (.zip)

Showing a partial file list — download the zip above to see everything.

- - README.md
- luacov-stats-aggregator.lua
- test_suites.json
- devcontainer.json
- docker-compose.yml
- Dockerfile
- - bug_report.yaml
  - config.yml
- - add-release-pongo.yml
  - ast-grep.yml
  - auto-assignee.yml
  - autodocs.yml
  - backport-fail-bot.yml
  - backport-v2.yml
  - build.yml
  - build_and_test.yml
  - buildifier.yml
  - changelog-requirement.yml
  - changelog-validation.yml
  - cherry-picks-v2.yml
  - community-stale.yml
  - copyright-check.yml
  - deck-integration.yml
  - label-check.yml
  - label-community-pr.yml
  - label-schema.yml
  - labeler-v2.yml
  - openresty-patches-companion.yml
  - release.yml
  - update-ngx-wasm-module.yml
  - update-test-runtime-statistics.yml
  - upgrade-tests.yml
- dependabot.yml
- labeler.yml
- matrix-commitly.yml
- matrix-full.yml
- PULL_REQUEST_TEMPLATE.md
- - data.lua
  - generate.lua
- - generate.lua
- README.md
- busted
- kong
- kong-health
- - BUILD.bazel
  - README.md
  - repositories.bzl
- - deb.Dockerfile
  - entrypoint.sh
  - rpm.Dockerfile
- - BUILD.bazel
  - crates.bzl
  - deps.bzl
- - BUILD.bazel
  - BUILD.libexpat.bazel
  - repositories.bzl
- - BUILD.bazel
  - BUILD.luarocks.bazel
  - luarocks_repositories.bzl
  - luarocks_wrap_script.lua
- - BUILD.bazel
  - BUILD.nfpm.bazel
  - repositories.bzl
  - rules.bzl
- - BUILD.bazel
  - BUILD.openresty.bazel
  - lua-resty-lmdb-cross.patch
  - repositories.bzl
- - kong.logrotate
  - kong.service
  - nfpm.yaml
  - postinstall.sh
- - 01-revert-LD-environment.patch
  - 02-revert-Reduce-build-times-especially-on-windows.patch
- - venv-commons
  - venv.fish
  - venv.sh
- - .gitignore
  - bindings.bzl
  - BUILD
  - cc_toolchain_config.bzl
  - generate_wrappers.sh
  - managed_toolchain.bzl
  - repositories.bzl
- BUILD.bazel
- build_system.bzl
- kong_bindings.bzl
- Makefile
- README.md
- repositories.bzl
- - 3.5.0.md
- - 3.6.0.md
- - 3.7.0.md
- - 3.8.0.md
- - 3.9.0.md
- changelog-template.yaml
- create_pr
- kong-diagram.png
- Makefile
- README.md
- verify-prs
- atc_router.Cargo.lock
- atc_router.lock
- README.md
- - init.lua
  - utils.lua
- - api_helpers.lua
  - arguments.lua
  - arguments_decoder.lua
  - endpoints.lua
  - init.lua
- - init.lua
  - warmup.lua
- - init.lua
- - config_helper.lua
  - control_plane.lua
  - data_plane.lua
  - events.lua
  - init.lua
  - tls.lua
  - utils.lua
- - check.lua
  - config.lua
  - drain.lua
  - health.lua
  - hybrid.lua
  - init.lua
  - migrations.lua
  - prepare.lua
  - quit.lua
  - reload.lua
  - restart.lua
  - roar.lua
  - start.lua
  - stop.lua
  - vault.lua
  - version.lua
- - constants.lua
  - init.lua
  - listeners.lua
  - parse.lua
  - sys.lua
- - errors.lua
  - init.lua
  - iteration.lua
  - utils.lua
- - client.lua
  - README.md
  - stats.lua
  - utils.lua
- - init.lua
  - README.md
- - init.lua
- - logs.lua
- - client.lua
  - cluster.lua
  - ctx.lua
  - init.lua
  - ip.lua
  - log.lua
  - nginx.lua
  - node.lua
  - plugin.lua
  - request.lua
  - response.lua
  - router.lua
  - service.lua
  - table.lua
  - telemetry.lua
  - tracing.lua
  - vault.lua
- - ctx.lua
- - atc.lua
  - compat.lua
  - expressions.lua
  - fields.lua
  - init.lua
  - traditional.lua
  - transform.lua
  - utils.lua
- - certificate.lua
  - events.lua
  - handler.lua
  - log_level.lua
  - plugins_iterator.lua
  - upstream_retry.lua
  - upstream_ssl.lua
  - wasm.lua
- - init.lua
  - ready.lua
- - kong_defaults.lua
  - kong_yml.lua
  - nginx.lua
  - nginx_inject.lua
  - nginx_kong.lua
  - nginx_kong_gui_include.lua
  - nginx_kong_inject.lua
  - nginx_kong_stream.lua
  - nginx_kong_stream_inject.lua
  - wasmtime_cache_config.lua
- - context.lua
  - init.lua
- - aws_stream.lua
  - cjson.lua
  - dns.lua
  - emmy_debugger.lua
  - grpc.lua
  - gzip.lua
  - http.lua
  - ip.lua
  - kong-lua-sandbox.lua
  - mime_type.lua
  - module.lua
  - protobuf.lua
  - queue.lua
  - queue_schema.lua
  - rand.lua
  - request_aware_table.lua
  - sha256.lua
  - stream_api.lua
  - string.lua
  - system.lua
  - table.lua
  - time.lua
  - timestamp.lua
  - uri.lua
  - utils.lua
  - uuid.lua
  - yield.lua
- - init.lua
- concurrency.lua
- constants.lua
- deprecation.lua
- error_handlers.lua
- global.lua
- globalpatches.lua
- hooks.lua
- init.lua
- meta.lua
- reports.lua
- - 00-create-pg-db.sh
  - common.sh
  - docker-compose-test-services.yml
  - up.fish
  - up.sh
- - .gitignore
  - config.py
  - docker_image_filelist.txt
  - expect.py
  - explain.py
  - filelist.txt
  - main.py
  - requirements.txt
  - suites.py
- - docker-compose.yml
  - luarocks-system-lua
  - source-versions
  - test-upgrade-path.sh
- autodoc
- build-wasm-test-filters.sh
- changelog-helper.lua
- check-labeler.pl
- check_spec_files_spelling.sh
- Dockerfile
- grep-kong-version.sh
- make-release
- release-kong.sh
- release-lib.sh
- update-copyright
- validate-rockspec
- - 02-rockspec_meta_spec.lua
  - 03-conf_loader_spec.lua
  - 04-prefix_handler_spec.lua
  - 05-utils_spec.lua
  - 06-timestamp_spec.lua
  - 07-api_helpers_spec.lua
  - 08-router_spec.lua
  - 10-log_serializer_spec.lua
  - 11-reports_spec.lua
  - 12-plugins_order_spec.lua
  - 13-plugins_version_spec.lua
  - 14-dns_spec.lua
  - 16-runloop_handler_spec.lua
  - 17-concurrency_spec.lua
  - 18-tools_uri_spec.lua
  - 19-hooks_spec.lua
  - 20-sandbox_spec.lua
  - 22-grpc-utils_spec.lua
  - 23-vaults_spec.lua
  - 24-runloop_certificate_spec.lua
  - 25-msgpack_rpc_spec.lua
  - 26-mime-type_spec.lua
  - 27-queue_spec.lua
  - 28-inject_confs_spec.lua
  - 29-lua_cjson_large_str_spec.lua
  - 30-standardized_redis_config_spec.lua
  - 31-ada-url_spec.lua
  - 32-tools_string_spec.lua
- - 01-legacy_queue_parameter_warning_spec.lua
  - 02-legacy_propagation_parameter_warning_spec.lua
- - 1.2_custom_nginx.template
  - admin_api.lua
  - aws-lambda.lua
  - aws-sam.lua
  - balancer_utils.lua
  - blueprints.lua
  - burst.yml
  - custom_nginx.template
  - dc_blueprints.lua
  - default_status_listen.conf
  - dump_lmdb_key.lua
  - forward-proxy-server.lua
  - headers.conf
  - hosts
  - https_server.lua
  - invalid-module.lua
  - invalid.conf
  - invalid_nginx_directives.conf
  - kong_clustering.crt
  - kong_clustering.key
  - kong_clustering_ca.crt
  - kong_clustering_client.crt
  - kong_clustering_client.key
  - kong_spec.crt
  - kong_spec.key
  - mock_cp.lua
  - mock_upstream.lua
  - mock_webserver_tpl.lua
  - mocker.lua
  - nginx-directives.conf
  - reload.conf
  - router_path_handling_tests.lua
  - shared_dict.lua
  - shm-stub.lua
  - ssl.lua
  - stress_generator.lua
  - to-strip.conf
  - valid-module.lua
- - dns.lua
  - http_mock.lua
  - perf.lua
  - redis_helper.lua
  - wait.lua
- - asserts.lua
  - client.lua
  - cmd.lua
  - conf.lua
  - constants.lua
  - db.lua
  - dns.lua
  - grpc.lua
  - misc.lua
  - module.lua
  - pid.lua
  - server.lua
  - shell.lua
  - ssl.lua
  - sys.lua
  - wait.lua
- busted-ci-helper.lua
- config.ld
- helpers.lua
- hybrid.lua
- kong_tests.conf
- ldoc.css
- on_demand_specs
- README.md
- renderdocs.sh
- require.lua
- upgrade_helpers.lua
- - 01-table.t
.bazelignore
.bazelrc
.bazelversion
.busted
.editorconfig
.gitignore
.luacheckrc
.luacov
.requirements
BUILD.bazel
CHANGELOG-OLD.md
CHANGELOG.md
CODE_OF_CONDUCT.md
COMMUNITY_PLEDGE.md
CONTRIBUTING.md
COPYRIGHT
DEVELOPER.md
kong-admin-api.yml
kong-latest.rockspec
kong.conf.default
LICENSE
Makefile
MODULE.bazel
README.md
SECURITY.md
sgconfig.yml
UPGRADE.md
WORKSPACE

# Installation Guide

1. Get the code

git clone https://github.com/Kong/kong

Downloads the entire project code from GitHub to your computer.

cd kong

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

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.

$ git clone https://github.com/Kong/docker-kong

Type this command into your terminal and run it.

$ cd docker-kong/compose/

Type this command into your terminal and run it.

$ KONG_DATABASE=postgres docker-compose --profile database up

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

pip install -r scripts/explain_manifest/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

4. Make

Medium

Prerequisites

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

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.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

kong

File Explorer

# Installation Guide

2. Docker

3. Python

4. Make

Today's picks

Was this content helpful?

Recent Feedback

kong

File Explorer

# Installation Guide

2. Docker

3. Python

4. Make

Today's picks

Was this content helpful?

Recent Feedback

Download README