{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.}
{Longer description of what the image provides.}
Please read the documentation on how Fonoster services are created and how to work with them.
{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.
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%%
{An example of running the container. Most Routr services use docker compose, and docker run is also beneficial.}
The following is a basic example of using this image.
docker run ...
or with Node:
npm i npm start
Optional specification notes.
{List of packages and tools, H3 section breakouts for more detail}
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. RequiredEXAMPLE_VAR2- Example of optional variable
51904- Default Processor port
/your/file/location- File location/some/special/script.sh- List special scripts
/some/special/script.sh- List special scripts/magic/dir- And also directories
Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests to us.
See the List of contributors who participated in this project.
Copyright (C) 2025 by Fonoster Inc. MIT License (see LICENSE for details).