Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add reading file from a container #1151

Merged
merged 1 commit into from
Apr 8, 2024
Merged
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
12 changes: 12 additions & 0 deletions docs/api/create_docker_container.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,18 @@ _ = new ContainerBuilder()
.WithResourceMapping(Encoding.Default.GetBytes("{}"), "/app/appsettings.json");
```

## Reading files from the container

The `IContainer` interface offers a `ReadFileAsync(string, CancellationToken)` method to read files from the container. The implementation returns the read bytes. Either process the read bytes in-memory or persist them to the disk.

```csharp title="Reading a file"
var readBytes = await container.ReadFileAsync("/app/appsettings.json")
.ConfigureAwait(false);

await File.WriteAllBytesAsync("appsettings.json", readBytes)
.ConfigureAwait(false);
```

## Examples

An NGINX container that binds the HTTP port to a random host port and hosts static content. The example connects to the web server and checks the HTTP status code.
Expand Down
Loading