Skip to content

Commit

Permalink
Update README.md (#4678)
Browse files Browse the repository at this point in the history
  • Loading branch information
poornimanayar authored Feb 6, 2025
1 parent be4fa66 commit b882944
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ ServiceControl, ServiceControl.Audit, and ServiceControl.Monitoring can be run/d

- Edit the `app.config` file of the instance type that needs to be run/debugged to select which transport and persistence to use.
- The configuration file contains commented settings for each supported transport and persistence. It also provides some guidance on additional required settings for specific persisters.
- ServiceControl works with a RavenDB persistence
- ServiceControl.Audit can work with RavenDB or an InMemory persistence
- Run or debug the project as usual

A video demo showing how to set it up is available on the Particular YouTube channel:
Expand All @@ -27,10 +29,6 @@ It's also possible to [locally test containers built from PRs in GitHub Containe
If the instance is executed for the first time, it must set up the required infrastructure. To do so, once the instance is configured to use the selected transport and persister, run it in setup mode. This can be done by using the `Setup {instance name}` launch profile that is defined in
the `launchSettings.json` file of each instance. When started in setup mode, the instance will start as usual, execute the setup process, and exit. At this point the instance can be run normally by using the non-setup launch profile.

### Run Instances on Learning transport

To help with local testing, the Learning transport has been added to the list of available transports when setting up a new instance in SCMU. For it to become available, an environment variable `ServiceControl_IncludeLearningTransport` needs to be created with a value of `true`.

## Secrets

Testing using the [CI workflow](/.github/workflows/ci.yml) depends on the following secrets, which must be defined for both Actions and Dependabot secrets. The Particular values for these secrets are stored in the secure note named **ServiceControl Repo Secrets**.
Expand Down Expand Up @@ -83,4 +81,4 @@ Steps:
-ErrorQueue errormq `
-ErrorRetentionPeriod 10:00:00:00 `
-Acknowledgements RabbitMQBrokerVersion310
```
```

0 comments on commit b882944

Please sign in to comment.