ngrok README

The project's README from github.com/inconshreveable/ngrok. As one markdown file: README.md.

ngrok - Unified Ingress for Developers

https://ngrok.com

ngrok Community on GitHub

If you are having an issue with the ngrok cloud service please open an issue on the ngrok community on GitHub

This repository is archived

This is the GitHub repository for the old v1 version of ngrok which was actively developed from 2013-2016.

This repository is archived: ngrok v1 is no longer developed, supported or maintained.

Thank you to everyone who contributed to ngrok v1 it in its early days with PRs, issues and feedback. If you wish to continue development on this codebase, please fork it.

ngrok's cloud service continues to operate and you can sign up for it here: https://ngrok.com/signup

What is ngrok?

ngrok is a globally distributed reverse proxy that secures, protects and accelerates your applications and network services, no matter where you run them. You can think of ngrok as the front door to your applications. ngrok combines your reverse proxy, firewall, API gateway, and global load balancing into one. ngrok can capture and analyze all traffic to your web service for later inspection and replay.

To use ngrok, sign up at https://ngrok.com/signup

ngrok open-source development

ngrok continues to contribute to the open source ecosystem at https://github.com/ngrok with:

What is ngrok for?

What can you do with ngrok?

ngrok (inconshreveable/ngrok)

Searching Database…

24.4K ·GitHub
archived
Что это такое?ngrok — это глобально распределённый обратный прокси, который защищает, охраняет и ускоряет приложения и сетевые сервисы независимо от того, где они запущены. Он объединяет в одном инструменте обратный прокси, файрвол, API-шлюз и глобальный балансировщик нагрузки.
Это текущая версия ngrok или что-то более старое?Этот репозиторий содержит старую кодовую базу v1 за 2013–2016 годы; он находится в архиве, больше не развивается, не поддерживается и не обслуживается. Нынешний продукт «ngrok» — это отдельный облачный сервис, который работает и на который можно зарегистрироваться.
Как мне на самом деле пользоваться ngrok?Зарегистрируйтесь в облачном сервисе ngrok и запустите агент ngrok как точку входа к вашему приложению; сам этот репозиторий не нужно устанавливать для использования сервиса.
Могу ли я всё ещё собирать и дорабатывать этот код v1?Можете, но официальной поддержки, исправлений и обновлений он не получает; авторы советуют сделать форк, если вы хотите продолжать разработку на этой старой кодовой базе.
Для кого создан ngrok?Для разработчиков, которым нужно открыть локальные или внутренние сервисы в интернете для демонстраций, тестирования вебхуков, API-шлюзов или подключения устройств.
Что я могу реально делать с ngrok?Типичные сценарии: соединение «сайт — сайт» с сетями заказчиков, демонстрация локальных приложений без их развёртывания, тестирование вебхуков с повторной отправкой HTTP-обратных вызовов, работа глобального API-шлюза с ограничением частоты запросов и авторизацией JWT, подключение API IoT-устройств к облаку, а также просмотр и повторная отправка HTTP-трафика.
Есть ли SDK для встраивания ngrok в мой код?Да, ngrok поддерживает SDK для агентов на Python, JavaScript, Go, Rust и Java, а также оператор для Kubernetes — это часть его текущей работы с открытым исходным кодом (отдельно от этого архивного репозитория v1).
Стоит ли начинать новый проект с этого репозитория?Нет. Поскольку это неподдерживаемая кодовая база v1, новым пользователям лучше зарегистрироваться в действующем облачном сервисе ngrok, а не собирать проект из этого архивного исходного кода.
What are similar projects?frp, tyk, nps, nginx, apisix, traefik, SafeLine, zuul
Size
0.7 MB
Stars
24.4K
Updated
CommitApr 26
Age
13y
Commits · 90 Days