https://github.com/bearsampp/module-ngrok
Ngrok module for the Bearsampp project
https://github.com/bearsampp/module-ngrok
hacktoberfest ngrok
Last synced: 6 months ago
JSON representation
Ngrok module for the Bearsampp project
- Host: GitHub
- URL: https://github.com/bearsampp/module-ngrok
- Owner: Bearsampp
- License: gpl-3.0
- Created: 2021-11-26T20:57:57.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-16T06:25:50.000Z (6 months ago)
- Last Synced: 2026-01-16T21:51:11.841Z (6 months ago)
- Topics: hacktoberfest, ngrok
- Homepage: https://bearsampp.com/module/ngrok
- Size: 2.34 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
[](https://github.com/bearsampp/module-ngrok/releases/latest)
This is a module of [Bearsampp project](https://github.com/bearsampp/bearsampp) involving ngrok.
## Documentation and downloads
https://bearsampp.com/module/ngrok
## Build
This project uses Gradle for building and packaging releases.
### Requirements
* Java 8 or higher
* Gradle (or use the Gradle wrapper if available)
* 7-Zip (optional, for `.7z` format; falls back to `.zip` if not available)
### Quick Start
```bash
# List all available tasks
gradle tasks
# Build a specific version interactively
gradle release
# Build a specific version non-interactively
gradle release -PbundleVersion=3.19.1
# Build all available versions
gradle releaseAll
# Display build information
gradle info
# Verify build environment
gradle verify
# List available local versions
gradle listVersions
# List available remote releases
gradle listReleases
# Clean build artifacts
gradle clean
```
### Configuration
Edit `build.properties` to configure the build:
```properties
bundle.name = ngrok
bundle.release = YYYY.MM.DD
bundle.type = tools
bundle.format = 7z
```
### How It Works
1. **Version Detection**: Gradle scans the `bin/` directory for folders matching `bin/ngrok` (e.g., `bin/ngrok3.19.1`)
2. **Binary Download**: If `ngrok.exe` is not present locally, it's downloaded from the [modules-untouched](https://github.com/Bearsampp/modules-untouched) repository
3. **Staging**: Files are staged in `bearsampp-build/tmp/bundles_prep/tools/ngrok/`
4. **Packaging**: The final archive is created in `bearsampp-build/tools/ngrok//` with hash files (MD5, SHA1, SHA256, SHA512)
### Output
Archives are created with the naming pattern:
```
bearsampp-ngrok--.
```
For example: `bearsampp-ngrok-3.19.1-2025.02.16.7z`
### Advanced Options
**Override download URL:**
```bash
gradle release -PbundleVersion=3.19.1 -PngrokUrl=https://example.com/ngrok.exe
# or set environment variable
set NGROK_DOWNLOAD_URL=https://example.com/ngrok.exe
```
**Use local ngrok.exe:**
```bash
gradle release -PbundleVersion=3.19.1 -PngrokLocalExe=C:/path/to/ngrok.exe
# or set environment variable
set NGROK_EXE_PATH=C:/path/to/ngrok.exe
```
**Custom build path:**
```bash
# In build.properties
build.path = C:/custom-build-path
# or set environment variable
set BEARSAMPP_BUILD_PATH=C:/custom-build-path
```
### Documentation
For detailed documentation, see the [.gradle-docs](.gradle-docs/) directory.
## Issues
Issues must be reported on [Bearsampp repository](https://github.com/bearsampp/bearsampp/issues).