https://github.com/dacr/web-echo

A websocket/webhook JSON data recorder with API
https://github.com/dacr/web-echo

actor-model api data-recording json openapi pekko pekko-http pekko-streams recorder webhook websocket

Last synced: 15 days ago
JSON representation

A websocket/webhook JSON data recorder with API

• Host: GitHub
• URL: https://github.com/dacr/web-echo
• Owner: dacr
• License: other
• Created: 2020-12-06T14:34:53.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-11-17T10:45:21.000Z (about 1 month ago)
• Last Synced: 2024-11-17T11:25:45.533Z (about 1 month ago)
• Topics: actor-model, api, data-recording, json, openapi, pekko, pekko-http, pekko-streams, recorder, webhook, websocket
• Language: Scala
• Homepage:
• Size: 2.36 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![](images/logo-base-32.png) web-echo ![tests][tests-workflow] [![License][licenseImg]][licenseLink] [![][WebEchoImg]][WebEchoLnk]

web-echo service allows you to easily define on the fly JSON recorders which can be 

fed by remote services using either the dynamically generated webhook or the websockets

you've provided. Then, at any time you can check what have been sent by the configured

remote services. [Check the swagger API specification][webecho-api] for more information.

It has been deployed on https://mapland.fr/echo

## Quick local start

Thanks to [scala-cli][scl],

this application is quite easy to start, just execute :

```

scala-cli --dep fr.janalyse::web-echo:1.2.6 -e 'webecho.Main.main(args)'

```

## Configuration

| Environment variable | Description                            | default value              |

|----------------------|----------------------------------------|----------------------------|

| WEB_ECHO_LISTEN_IP   | Listening network interface            | "0.0.0.0"                  |

| WEB_ECHO_LISTEN_PORT | Listening port                         | 8080                       |

| WEB_ECHO_PREFIX      | Add a prefix to all defined routes     | ""                         |

| WEB_ECHO_URL         | How this service is known from outside | "http://127.0.0.1:8080"    |

| WEB_ECHO_STORE_PATH  | Where data is stored                   | "/tmp/web-echo-cache-data" |

[cs]: https://get-coursier.io/

[scl]: https://scala-cli.virtuslab.org/

[webecho-api]: https://mapland.fr/echo/swagger

[WebEcho]: https://github.com/dacr/web-echo

[WebEchoImg]: https://img.shields.io/maven-central/v/fr.janalyse/web-echo_2.13.svg

[WebEchoLnk]: https://search.maven.org/#search%7Cga%7C1%7Cfr.janalyse.web-echo

[tests-workflow]: https://github.com/dacr/web-echo/actions/workflows/scala.yml/badge.svg

[licenseImg]: https://img.shields.io/github/license/dacr/web-echo.svg

[licenseLink]: LICENSE