# Ngrok Config

## Download Ngrok

1. Visit the [Ngrok ](https://ngrok.com/)website and sign up or log in.
2. Navigate to the [download section](https://dashboard.ngrok.com/get-started/setup/macos) and select the version for Mac OS.
3. Install Ngrok using the brew command 

```
brew install ngrok/ngrok/ngrok
```

4. Copy the Auth Token and keep it separately later this will be used to set the **ngrok.yml** config file

<figure><img src="https://17901342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBwEhITzgv0O0fEGIIRN%2Fuploads%2FoIH25tXJu4o6TY704FFM%2Fngrok%20download%20macos.png?alt=media&#x26;token=84b505b0-8e0f-4d60-8dae-49628f8c1b93" alt=""><figcaption></figcaption></figure>

## Setting up the Ngrok Free Custom Domain

Go to the **Ngrok portal**, navigate to **Domains -> New Domain**, and create your free domain.

<figure><img src="https://17901342-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FmBwEhITzgv0O0fEGIIRN%2Fuploads%2Fga6ttI0qb1fKE5408nPm%2FNgrok%20Free%20Custom%20Domain.webp?alt=media&#x26;token=52211b6d-d144-4904-af81-923da134008d" alt=""><figcaption></figcaption></figure>

## Setting up the Ngrok Config File

1. Open the terminal in Mac
2. Enter the command `ngrok config edit`.
3. This opens the ngrok config file. Enter your Auth Token, Tunnel Name, hostname, and addr as follows:

```markup
version: "3"
tunnels:
    flask:
        proto: http
        hostname: <your-ngrok-free-domain>.ngrok-free.app
        addr: 127.0.0.1:5000
agent:
    authtoken: <your-ngrok-auth-token>
```

Replace `<Your Auth Token>` with your actual Ngrok authentication token and `<your-chosen-hostname>` with the hostname you’ve set up.

## &#x20;Security Best Practices When Using Ngrok

* **Keep Your Ngrok Auth Token Secure**: Your Ngrok authentication token is the key to creating tunnels with your account. Keep it secure to prevent unauthorized access.
* **Use Strong Authentication for Exposed Services**: If you’re exposing a web service or application, ensure it has its own strong authentication mechanism.
* **Monitor Tunnel Usage**: Regularly review logs and monitor tunnel usage for any unexpected or unauthorized access.
* **Limit Exposure Time**: Only keep tunnels open for as long as necessary. The longer a tunnel is open, the higher the potential security risk.