Skip to content

Commit

Permalink
docs: Add docs for S3-compatible storage (#136)
Browse files Browse the repository at this point in the history
Co-authored-by: Fernando Arias <[email protected]>
  • Loading branch information
ferarias and Fernando Arias authored May 5, 2024
1 parent efc501b commit 2494ff4
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion docs/docs/Installation/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This page is a work in progress!

:::

Use Amazon Web Services to scale BaGetter. You can store metadata on [Amazon Relational Database Service (RDS)](https://aws.amazon.com/rds) and upload packages to [Amazon S3](https://aws.amazon.com/s3/).
Use Amazon Web Services to scale BaGetter. You can store metadata on [Amazon Relational Database Service (RDS)](https://aws.amazon.com/rds) and upload packages to [Amazon S3](https://aws.amazon.com/s3/) or any other S3-compatible service.

## Configure BaGetter

Expand All @@ -36,6 +36,33 @@ Update the `appsettings.json` file with those:
}
```

#### S3-compatible object storage

You can use any other S3-compatible storage service, as long as it's compatible with Amazon AWS S3. Since the URL for services other than Amazon AWS will change, you need to provide this Service URL instead of the Region. For example:

```json
{
...

"Storage": {
"Type": "AwsS3",
"Endpoint": "https://eu-central-1.linodeobjects.com",
"Bucket": "nuget-packages",
"AccessKey": "",
"SecretKey": ""
},

...
}
```

Note: to avoid errors, only one of `Region` or `Endpoint` setting can be set at the same time.

#### Known compatible services

So far, it has been tested in [Linode’s Object Storage](https://www.linode.com/docs/products/storage/object-storage/). If you succeed in using other storage service, let us know so we can state it here.


### Amazon RDS

<Tabs groupId="database-types">
Expand Down

0 comments on commit 2494ff4

Please sign in to comment.