https://github.com/shkoliar/magento-ngrok

Magento 2 module for ngrok.io service support
https://github.com/shkoliar/magento-ngrok

developer-tools development development-environment docker-ngrok local-development magento magento-2 magento-2-extension magento-2-module magento-extension magento-module magento2 magento2-extension magento2-module mit mit-license ngrok worksonmymachine

Last synced: about 2 months ago
JSON representation

Magento 2 module for ngrok.io service support

• Host: GitHub
• URL: https://github.com/shkoliar/magento-ngrok
• Owner: shkoliar
• License: mit
• Created: 2019-06-10T23:14:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-29T15:05:00.000Z (over 1 year ago)
• Last Synced: 2024-07-17T23:14:49.987Z (2 months ago)
• Topics: developer-tools, development, development-environment, docker-ngrok, local-development, magento, magento-2, magento-2-extension, magento-2-module, magento-extension, magento-module, magento2, magento2-extension, magento2-module, mit, mit-license, ngrok, worksonmymachine
• Language: PHP
• Homepage: https://shkoliar.com
• Size: 20.5 KB
• Stars: 44
• Watchers: 5
• Forks: 22
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Magento 2 ngrok

Magento 2 module for [ngrok](https://ngrok.com) service support. Automatically updates Magento base url based on domain used in the request. Modifies full-page and block-html caching to separate Magento caches for local and ngrok domains. No broken links or non loaded scripts and styles while browsing Magento web instance.

## Installation

To install the module to your local Magento 2 dev environment, simply run the command below.

```bash

composer require --dev shkoliar/magento-ngrok

```

The next step is to check if module is installed and exists in the modules list.

```bash

bin/magento module:status

```

And the last part is enabling the module.

```bash

bin/magento module:enable Shkoliar_Ngrok

```

Optionally you may want to run also `bin/magento setup:upgrade` and `bin/magento setup:di:compile` commands to ensure that the enabled modules are properly registered and classes are generated.

## Usage

Module itself does not require any configuration, it checks for request domain and activated only if it's `.ngrok.io`. So it works only when it needed for [ngrok](https://ngrok.com) secure tunnels.

## License

[MIT](../../blob/master/LICENSE)