Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
drichelson committed May 28, 2024
1 parent 854cadf commit 08fc7cb
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Dorkly Flags 'Backend' (in quotes because it's mostly just a GitHub Action)
Not sure what's going on here? Check out the project overview [here](https://github.com/dorklyorg)

This repo contains the backend bits for the Dorkly Flags project:
1. Go code that runs in GitHub Actions to convert human-friendly yaml files to a format that can be consumed by the ld-relay appliance.
2. Dockerfile to build the image used in the deployed backend service.

## Everything below here is a work in progress and is probably not accurate.

### Process:
1. Load config
Expand All @@ -10,10 +18,7 @@
8. Create ld-relay archive of json + checksum files
9. Save locally (testing) or upload to S3 (production)

## Relevant Links
[Feature Flags](https://launchdarkly.com/features/feature-flags/)
[Relay Proxy Configuration](https://docs.launchdarkly.com/sdk/features/relay-proxy-configuration/proxy-mode)
https://docs.launchdarkly.com/sdk/relay-proxy/sdk-config


### Go code
The go code in this repo runs in GitHub Action provisioned by the [dorklyorg/dorkly-flags Terraform module](https://registry.terraform.io/modules/dorklyorg/dorkly-flags/aws/latest).
Expand Down

0 comments on commit 08fc7cb

Please sign in to comment.