github.com/kubri/kubri@v0.5.1-0.20240317001612-bda2aaef967e/website/docs/configuration/target/s3.md (about)

     1  ---
     2  sidebar_position: 1
     3  sidebar_label: S3
     4  ---
     5  
     6  # S3 Target
     7  
     8  Uploads your repositories to an Amazon S3 or S3-compatible bucket.
     9  
    10  ## Environment variables
    11  
    12  | Name                    | Description                                                                                                                  |
    13  | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
    14  | `AWS_ACCESS_KEY_ID`     | The access key for your AWS account or S3-compatible service.                                                                |
    15  | `AWS_SECRET_ACCESS_KEY` | The secret key for your AWS account or S3-compatible service.                                                                |
    16  | `AWS_SESSION_TOKEN`     | The session key for your AWS account or S3-compatible service. This is only needed when you are using temporary credentials. |
    17  
    18  ## Configuration
    19  
    20  | Name          | Description                                                                           |
    21  | ------------- | ------------------------------------------------------------------------------------- |
    22  | `type`        | Must be `s3`.                                                                         |
    23  | `bucket`      | Storage bucket name.                                                                  |
    24  | `endpoint`    | The endpoint of your S3-compatible server. Not required if using Amazon S3.           |
    25  | `region`      | The bucket region.                                                                    |
    26  | `disable-ssl` | Disable SSL.                                                                          |
    27  | `folder`      | The folder to store your artifacts in. Defaults to the bucket root.                   |
    28  | `url`         | The public URL of your bucket. Defaults to `https://storage.googleapis.com/<bucket>`. |
    29  
    30  ## Examples
    31  
    32  ### Amazon S3
    33  
    34  ```yaml
    35  target:
    36    type: s3
    37    bucket: my-bucket
    38    region: us-east-1
    39    folder: my-folder
    40    url: https://download.example.com
    41  ```
    42  
    43  ### Cloudflare R2
    44  
    45  ```yaml
    46  target:
    47    type: s3
    48    bucket: my-bucket
    49    region: auto
    50    folder: my-folder
    51    endpoint: https://<accountId>.r2.cloudflarestorage.com
    52    url: https://download.example.com
    53  ```