-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* chore(#5): wrote docs for basic usage of generic image and gha image * chore(#5): Added badges for build, release, and license
- Loading branch information
Showing
1 changed file
with
50 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,50 @@ | ||
# docker-temporal-dev-server | ||
Temporal.io Development Server Container Image | ||
# Temporal.io Development Server | ||
|
||
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/InfinityFlowApp/docker-temporal-dev-server/release.yml)](https://github.com/InfinityFlowApp/docker-temporal-dev-server/actions?query=branch%3Amain) | ||
[![GitHub Release](https://img.shields.io/github/v/release/InfinityFlowApp/docker-temporal-dev-server)](https://github.com/InfinityFlowApp/docker-temporal-dev-server/releases) | ||
[![GitHub License](https://img.shields.io/github/license/InfinityFlowApp/docker-temporal-dev-server)](https://github.com/InfinityFlowApp/docker-temporal-dev-server?tab=MIT-1-ov-file) | ||
|
||
This repository contains Dockerfiles for setting up the Temporal.io Development Server in two variants: | ||
|
||
1. Generic: A flexible configuration suitable for general purposes. | ||
2. GitHub Actions: A specialized configuration with defaults set for use in GitHub Actions workflows, | ||
optimized for testing with a predefined namespace and only exposing port 7233. | ||
|
||
# Introduction | ||
|
||
Temporal.io is a microservices orchestration platform for running mission-critical code at any scale. | ||
This repository provides Dockerfiles for setting up a Temporal.io development server in two distinct configurations | ||
to aid in local development and continuous integration (CI) processes. | ||
|
||
# Running the Container | ||
|
||
Start the container using the appropriate variant: | ||
|
||
## Generic | ||
|
||
```shell | ||
docker run -p 7233:7233 -p 8233:8233 ghcr.io/infinityflowapp/temporal-dev-server:<version> | ||
``` | ||
|
||
## GitHub Actions Service | ||
|
||
Add or update the services section of your workflow | ||
|
||
```yaml | ||
jobs: | ||
<job>: | ||
services: | ||
<service>: | ||
image: ghcr.io/infinityflowapp/temporal-gha-service:<version> | ||
ports: | ||
- 7233:7233 | ||
``` | ||
|
||
Use a client pointing to your service (pseudo code) | ||
|
||
```java | ||
var client = new TemporalClient("<service>:7233"); | ||
``` | ||
|
||
# License | ||
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. |