Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ ungated
unsynchronized
WCAG
weweave
worktree
Xcodes.app
xcworkspace
xmldoc
Expand Down
11 changes: 7 additions & 4 deletions docs/getting-started/server/advanced-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ subscription.

## Emails

Docker compose will spin up a local smtp server, Mailcatcher, that can be used. See the
Aspire and Docker Compose both start a local SMTP server, Mailcatcher, that can be used. See the
[Setup Guide](./guide.md#mailcatcher) for more information about Mailcatcher.

It’s also possible to use other services such as Mailtrap, or Amazon to debug the amazon
Expand All @@ -63,8 +63,8 @@ integration.
File uploads are stored using one of two methods.

- Azure Storage is used by our production cloud instance.
- Docker will create a local [Azurite](https://github.com/Azure/Azurite) instance which emulates
the Azure Storage API. And is used for the primary testing.
- Aspire or Docker will create a local [Azurite](https://github.com/Azure/Azurite) instance which
emulates the Azure Storage API. And is used for the primary testing.
- We also have a test Azure Storage account for development use. The user secrets for this are
attached to the the "Server User Secrets" shared vault item. You'll need to copy the `send` and
`attachment` keys into your own user secrets.
Expand Down Expand Up @@ -136,13 +136,16 @@ The steps for setting up your local server for YubiKey validation are:
dotnet user-secrets set globalSettings:yubico:key [Key]
dotnet user-secrets set globalSettings:yubico:clientid [ClientId]
```
If you use Aspire, add these values to `dev/secrets.json` instead. Aspire clears and re-applies
user secrets from that file every time it starts.

## Reverse proxy setup

Running a reverse proxy can be used to simulate running multiple server services in a distributed
manner. The [Docker Compose](https://docs.docker.com/compose/) configuration in the `/dev` folder
already has a configuration prepared for the Api and Identity services (can be expanded for other
services).
services). Aspire doesn't start the reverse proxy or extra service instances, so start them as
described below.

1. The reverse proxy container is setup to use an
[nginx](https://nginx.org/en/docs/beginners_guide.html#conf_structure) config file located at
Expand Down
7 changes: 7 additions & 0 deletions docs/getting-started/server/database/ef/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,13 @@ The workflow here is broadly the same as with the normal MSSQL implementation: s
container, configure user secrets, and run migrations against their relating databases in
chronological order.

:::note

The Aspire `AppHost` only provides MSSQL. Use the [manual setup](../../guide.md#run-manually) and
the Docker Compose instructions below for Entity Framework databases.

:::

### Requirements

- A working local development server ([see steps](../../guide.md))
Expand Down
4 changes: 4 additions & 0 deletions docs/getting-started/server/database/mssql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ run migrations. You should run the helper script whenever you sync with the `mai
a new migration script. Migrations that have already been run are tracked in the `Migration` table
of your database.

If you run the server with [Aspire](../../guide.md#run-with-aspire), the `run-db-migrations`
resource runs this script every time the AppHost starts. To apply new migrations without restarting
the AppHost, restart `run-db-migrations` from the Aspire dashboard.

## Modifying the database

The process for modifying the database is described in
Expand Down
10 changes: 9 additions & 1 deletion docs/getting-started/server/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,13 @@ For a detailed look at the architecture and technical details, see
for writing events to Azure Table Storage). In addition, this assumes you're using the `mssql`
default profile and have the `${MSSQL_PASSWORD}` set via `.env`.

:::note

The emulator connects to the Docker Compose `mssql` container, so it doesn't work with the SQL
Server that Aspire starts. Use the [manual setup](./guide.md#run-manually) for Azure Service Bus.

:::
Comment on lines +50 to +55

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't Aspire also start azurite though? Why won't it work here?


2. Run Docker Compose to add/start the local emulator:

```bash
Expand Down Expand Up @@ -204,7 +211,8 @@ To emulate this locally:
default value of `UseDevelopmentStorage=true`

3. Start the Events and EventsProcessor projects using `dotnet run` or your IDE. (Also ensure you
have Api, Identity and your web vault running.)
have Api, Identity and your web vault running.) Aspire starts Events and EventsProcessor for
you.

You should now observe that your enterprise organization is logging events (e.g. when creating an
item or inviting a user). These should appear in the Event Logs section of the organization vault.
Expand Down
Loading
Loading