Mockoon and Ngrok Docker Setup

This repository contains the configuration to set up Mockoon and Ngrok using Docker. The setup allows you to run a mock API using Mockoon and expose it to the internet using Ngrok.

Prerequisites

Setup Instructions

Step 1: Ngrok Configuration

Register for an Ngrok Account:
- If you don't have an Ngrok account, sign up for a free account at ngrok.com.
Set Ngrok Authentication Token:
- Update the config/ngrok.yaml file with your Ngrok authentication token.

`config/ngrok.yaml`

version: "2"
authtoken: "<YOUR_NGROK_AUTH_TOKEN>"
tunnels:
  mockoon:
    proto: http
    addr: mockoon:3000

Replace <YOUR_NGROK_AUTH_TOKEN> with your actual Ngrok authentication token.

Step 2: Mockoon Configuration

Update mockoon.json:
- If you have custom Mockoon configurations, update the config/mockoon.json file accordingly. You can also generate this JSON file using the Mockoon Desktop.

Step 3: Entrypoint Script

Ensure Execution Permissions:
- Make sure the entrypoint.sh script has execution permissions.

chmod +x entrypoint.sh

Step 4: Start the Services

Run Docker Compose:
- Start the services using Docker Compose. You may need to use sudo depending on your Docker setup.

docker-compose down
docker-compose up -d

Step 5: Verify the Setup

Ngrok URL:
- Access the Ngrok web interface:
```
open http://localhost:4040
```
- Alternatively, you can check the logs of the Ngrok container to find the public URL:
```
docker logs ngrok
```
Mockoon Logs:
- Navigate to the logs directory on your host machine:
```
cd ./logs
```
- Check the contents of mockoon.log:
```
cat mockoon.log
```

Conclusion

By following these steps, you will have a Mockoon service running alongside an Ngrok service, providing a public URL to access your Mockoon API. This setup is useful for testing and developing mock APIs that need to be publicly accessible.

hieisky/mockApi