# app-service-configurable

**Repository Path**: azhw/app-service-configurable

## Basic Information

- **Project Name**: app-service-configurable
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-07
- **Last Updated**: 2025-09-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# App Service Configurable
[![Build Status](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/app-service-configurable/job/main/badge/icon)](https://jenkins.edgexfoundry.org/view/EdgeX%20Foundry%20Project/job/edgexfoundry/job/app-service-configurable/job/main/) [![Code Coverage](https://codecov.io/gh/edgexfoundry/app-service-configurable/branch/main/graph/badge.svg?token=wMrc2PZbwj)](https://codecov.io/gh/edgexfoundry/app-service-configurable) [![Go Report Card](https://goreportcard.com/badge/github.com/edgexfoundry/app-service-configurable)](https://goreportcard.com/report/github.com/edgexfoundry/app-service-configurable) [![GitHub Latest Dev Tag)](https://img.shields.io/github/v/tag/edgexfoundry/app-service-configurable?include_prereleases&sort=semver&label=latest-dev)](https://github.com/edgexfoundry/app-service-configurable/tags) ![GitHub Latest Stable Tag)](https://img.shields.io/github/v/tag/edgexfoundry/app-service-configurable?sort=semver&label=latest-stable) [![GitHub License](https://img.shields.io/github/license/edgexfoundry/app-service-configurable)](https://choosealicense.com/licenses/apache-2.0/) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/edgexfoundry/app-service-configurable) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr-raw/edgexfoundry/app-service-configurable)](https://github.com/edgexfoundry/app-service-configurable/pulls) [![GitHub Contributors](https://img.shields.io/github/contributors/edgexfoundry/app-service-configurable)](https://github.com/edgexfoundry/app-service-configurable/contributors) [![GitHub Committers](https://img.shields.io/badge/team-committers-green)](https://github.com/orgs/edgexfoundry/teams/app-service-configurable-committers/members) [![GitHub Commit Activity](https://img.shields.io/github/commit-activity/m/edgexfoundry/app-service-configurable)](https://github.com/edgexfoundry/app-service-configurable/commits)

> **Warning**  
> The **main** branch of this repository contains work-in-progress development code for the upcoming release, and is **not guaranteed to be stable or working**.
> It is only compatible with the [main branch of edgex-compose](https://github.com/edgexfoundry/edgex-compose) which uses the Docker images built from the **main** branch of this repo and other repos.
>
> **The source for the latest release can be found at [Releases](https://github.com/edgexfoundry/app-service-configurable/releases).**


App-Service-Configurable is provided as an easy way to get started with processing data flowing through EdgeX.

For latest documentation please visit https://docs.edgexfoundry.org/latest/microservices/application/services/AppServiceConfigurable/Purpose/

## Build Prerequisites

Please see the [edgex-go README](https://github.com/edgexfoundry/edgex-go/blob/main/README.md#prerequisites).

## Build with NATS Messaging
Currently, the NATS Messaging capability (NATS MessageBus) is opt-in at build time.
This means that the published Docker image does not include the NATS messaging capability.
```makefile
make build-nats - Builds local binary with NATS MessageBus support
make docker-nats - Builds local docker image with NATS MessageBus support
```
The locally built Docker image can then be used in place of the published Docker image in your compose file.
See [Compose Builder](https://github.com/edgexfoundry/edgex-compose/tree/main/compose-builder#gen) `nat-bus` option to generate compose file for NATS and local dev images.

## Build without OpenZiti zerotrust
Currently, the OpenZiti zerotrust capability is opt-out at build time. This means that the published Docker images include the OpenZiti zerotrust capability.

The following make commands will build the local binaries or local Docker images without OpenZiti zerotrust capability.

```makefile
make build-noziti
make docker-noziti
```

## Packaging

This component is packaged as docker image.

For docker, please refer to the [Dockerfile](Dockerfile) and [Docker Compose Builder](https://github.com/edgexfoundry/edgex-compose/tree/main/compose-builder) scripts.

## Versioning

Please refer to the EdgeX Foundry [versioning policy](https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=21823969) for information on how EdgeX services are released and how EdgeX services are compatible with one another.  Specifically, device services (and the associated SDK), application services (and the associated app functions SDK), and client tools (like the EdgeX CLI and UI) can have independent minor releases, but these services must be compatible with the latest major release of EdgeX.

## Long Term Support

Please refer to the EdgeX Foundry [LTS policy](https://wiki.edgexfoundry.org/pages/viewpage.action?pageId=69173332#LongTermSupport(v2)-LTS) for information on support of EdgeX releases. The EdgeX community does not offer support on any non-LTS release outside of the latest release.