thomas.nuyken/vegasco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add Aspire documentation to README
Some checks failed
continuous-integration/drone/push Build is failing
Details

Browse Source
This commit is contained in:
Thomas Nuyken
2024-12-28 17:08:01 +01:00
parent 6d23494fd3
commit ff2707a0e8
1 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,16 +1,16 @@
# Vegasco Server
Backend for the vegasco (***VE***hicle ***GAS*** ***CO***nsumption) application.
Backend for the vegasco (**VE**hicle **GAS** **CO**nsumption) application.
## Getting Started
### Configuration
| Configuration | Description | Default | Required |
|--------------------------|-------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|----------|
|--------------------------|---------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|----------|
| JWT:MetadataUrl | The oidc meta data url | - | true |
| JWT:ValidAudience | The valid audience of the JWT token. | - | true |
| JWT:NameClaimType | The claim type of the user's name claim. | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | false |
| JWT:NameClaimType | The claim type of the user's name claim. For keycloak, using `preferred_username` is often the better choice. | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | false |
| JWT:AllowHttpMetadataUrl | Whether to allow the meta data url to have http as protocol. Always true when `ASPNETCORE_ENVIRONMENT=true` | false | false |
The application uses the prefix `Vegasco_` for environment variable names. The prefix is removed when the application reads the environment variables and duplicate entries are overwritten by the environment variables.
@@ -56,3 +56,12 @@ As appsettings.json (or a environment specific appsettings.*.json):
}
}
```
### Running the application
The solution uses Aspire to orchestrate the application. Specifically, it introduces sensible service defaults, including but not limited to OpenTelemetry,
creates a Postgres database as a docker container, and starts the WebApi with the correct configuration to communicate with the database.
Ensure you have an identity provider set up, for example Keycloak, and configured the relevant options described above.
Then, to run the application, ensure you have Docker running, then run the `Vegasco.Server.AppHost` launch profile.