Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fonoster/nodejs-processor

A template with everything you need to start creating custom Routr processors
https://github.com/fonoster/nodejs-processor

asterisk freepbx kamailio opensips routr sip voip

Last synced: about 2 months ago
JSON representation

A template with everything you need to start creating custom Routr processors

Host: GitHub
URL: https://github.com/fonoster/nodejs-processor
Owner: fonoster
License: mit
Created: 2023-09-02T02:04:46.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-02-29T03:40:01.000Z (10 months ago)
Last Synced: 2024-05-01T09:42:07.961Z (8 months ago)
Topics: asterisk, freepbx, kamailio, opensips, routr, sip, voip
Language: TypeScript
Homepage: https://routr.io
Size: 367 KB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# Routr {Proccessor Name}

> {A short description of the image, same as the Github Repo description.}

{Badges should all be in one row without carriage returns. Replace the {name} with your docker image name.}

[![publish to docker hub](https://github.com/fonoster/nodejs-processor/actions/workflows/gh_docker.yml/badge.svg)](https://github.com/fonoster/nodejs-processor/actions/workflows/gh_docker.yml)

{Longer description of what the image provides.}

Please read the [documentation]() on how Fonoster services are created and how to work with them.

## Available Versions

{Keep this as-is, but replace {name} with your Docker image name.}

You can see all images available to pull from Docker Hub via the [Tags]() page. Docker tag names that begin with a "change type" word such as task, bug, or feature are available for testing and may be removed at any time.

## Installation

You can clone this repository and manually build it.

```
cd fonoster/routr-{processor}\:%%VERSION%%
docker build -t fonoster/routr-{processor}:%%VERSION%% .
```

Otherwise, you can pull this image from the docker index.

```
docker pull fonoster/routr-{processor}:%%VERSION%%
```

## Usage Example

{An example of running the container. Most Fonoster services use docker-compose, and docker run is also beneficial.}

The following is a basic example of using this image.

```bash
docker run ...
```

or with Node:

```bash
npm i
npm start
```

## Specs

Optional specification notes.

{List of packages and tools, H3 section breakouts for more detail}

## Environment Variables

Environment variables are used in the entry point script to render configuration templates. You can specify the values of these variables during `docker run`, `docker-compose up`, or in Kubernetes manifests in the `env` array.

{Each environment variable might have 1-2 sentences of description. For anything longer, we should probably have a sub-section within Specs to elaborate.}

- `EXAMPLE_VAR1` - Example of required variable. **Required**
- `EXAMPLE_VAR2` - Example of optional variable

## Exposed ports

- `51904` - Default Processor port

## Volumes

- `/your/file/location` - File location
- `/some/special/script.sh` - List special scripts

## Useful File Locations

- `/some/special/script.sh` - List special scripts
- `/magic/dir` - And also directories

## Contributing

Please read [CONTRIBUTING.md](https://github.com/fonoster/fonoster/blob/master/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests to us.

## Authors

- [Pedro Sanders](https://github.com/psanders)

See the List of contributors who [participated](https://github.com/fonoster/nodejs-processor/contributors) in this project.

## License