# ComposeFile.AddSecret

- Module: [Aspire.Hosting.Docker](/reference/api/go/aspire.hosting.docker.md)
- Defined on: [ComposeFile](/reference/api/go/aspire.hosting.docker/composefile.md)
- Version: `17.0.0`
- Kind: `method`

Adds a top-level secret definition to the Docker Compose file.

## Definition

```go
type ComposeFile interface {
    // ... omitted for brevity
    AddSecret(
        name string,
        options ...*AddSecretOptions,
    ) ComposeFile
}
```

## Signature

```go
AddSecret(
    name string,
    options ...*AddSecretOptions,
) ComposeFile
```

## Parameters

- `name` (`string`) -- The name of the secret.
- `options` (`...*AddSecretOptions`) -- optional settings, see [Options](#options)

## Options

Optional parameters are passed in a trailing `options ...*AddSecretOptions` argument.

- `File` (`*string`) -- The path to the secret file.
- `External` (`*bool`) -- A value indicating whether the secret is managed outside the generated Compose file.
- `Configure` (`func(obj Secret)`) `callback` -- An optional callback for further secret customization.

## Returns

[`ComposeFile`](/reference/api/go/aspire.hosting.docker/composefile.md) -- The updated Docker Compose file.

Returns a handle; failures surface later via `Err()`.

## Defined on

- [ComposeFile](/reference/api/go/aspire.hosting.docker/composefile.md) -- `handle`
