docs: Add fileservice guides for S3 and Spaces (#430)

* docs: Add fileservice guides for S3 and Spaces

* fix: remove we in s3 guide

* fix: typos in spaces guide
This commit is contained in:
Oliver Windall Juhl
2021-10-01 12:58:44 +02:00
committed by GitHub
parent 22f3f2af93
commit 337fc16c38
5 changed files with 169 additions and 0 deletions

View File

@@ -0,0 +1,85 @@
# Uploading images to S3
In order to work with images in Medusa, you need a file service plugin responsible for hosting. Following this guide will allow you to upload images to AWS S3.
### Before you start
At this point, you should have an instance of our store engine running. If not, we have a [full guide](https://docs.medusa-commerce.com/tutorial/set-up-your-development-environment) for setting up your local environment.
### Set up up AWS
#### Create an S3 bucket
In the AWS console navigate to S3 and create a bucket for your images. Make sure to uncheck "Block _all_ public access".
Additionally, you need to add a policy to your bucket, that will allow public access to objects that are uploaded. Navigate to the permissions tab of your bucket and add the following policy:
```shell=
{
"Id": "Policy1397632521960",
"Statement": [
{
"Sid": "Stmt1397633323327",
"Action": [
"s3:GetObject"
],
"Effect": "Allow",
"Resource": "arn:aws:s3:::YOUR-BUCKET-NAME/*",
"Principal": {
"AWS": [
"*"
]
}
}
]
}
```
Be aware, that this will allow for anyone to acces your bucket. Avoid storing sensitive data.
#### Generate access keys
Navigate to the IAM section of your AWS console and perform the following steps:
- Add a new user with programmatic access
- Add the existing **AmazonS3FullAccess** policy to the user
- Submit the details
Upon successfull creation of the user, you are presented with an **Access key ID** and a **Secret access key**. Note both of them down for later use.
### Installation
First, install the plugin using your preferred package manager:
```
yarn add medusa-file-s3
```
Then configure your `medusa-config.js` to include the plugin alongside the required options:
```=javascript
{
resolve: `medusa-file-s3`,
options: {
s3_url: "https://s3-guide-test.s3.eu-west-1.amazonaws.com",
bucket: "test",
region: "eu-west-1"
access_key_id: "YOUR-ACCESS-KEY",
secret_access_key: "YOUR-SECRET-KEY",
},
},
```
In the above options, an `s3_url` is included. The url has the following format:
```shell=
https://[bucket].s3.[region].amazonaws.com
```
The two access keys in the options are the ones created in the previous section.
> Make sure to use an environment variable for the secret key in a live environment.
### Try it out
Finally, run your Medusa server alongside our admin system to try out your new file service. Upon editing or creating products, you can now upload thumbnails and images, that are stored in an AWS S3 bucket.

View File

@@ -0,0 +1,36 @@
# Uploading images to Spaces
In order to work with images in Medusa, you need a file service plugin responsible for hosting. Following this guide will allow you to upload images to DigitalOcean Spaces.
### Before you start
At this point, you should have an instance of our store engine running. If not, we have a [full guide](https://docs.medusa-commerce.com/tutorial/set-up-your-development-environment) for setting up your local environment.
### Set up up DigitalOcean
#### Create a Space
Create an account on DigitalOcean and navigate to Spaces. Create a new Space with the default settings.
#### Generate access keys
Navigate to API in the left sidebar. Generate a new Spaces access key. This should provide you with an access key id and a secret key. Note them both down.
### Installation
First, install the plugin using your preferred package manager:
```
yarn add medusa-file-spaces
```
Then configure your `medusa-config.js` to include the plugin alongside the required options:
```=javascript
{
resolve: `medusa-file-spaces`,
options: {
spaces_url: "https://test.fra1.digitaloceanspaces.com",
bucket: "test",
endpoint: "fra1.digitaloceanspaces.com",
access_key_id: "YOUR-ACCESS-KEY",
secret_access_key: "YOUR-SECRET-KEY",
},
},
```
In the above options, a `spaces_url` is included. This can be found in your Space overview. The `bucket` should point to the name you gave your Space. The `endpoint` identifies the region in which you created the Space. And finally the two keys are the ones created in the previous section.
> Make sure to use an environment variable for the secret key in a live environment.
### Try it out!
Finally, run your Medusa server alongside our admin system to try out your new file service. Upon editing or creating products, you can now upload thumbnails and images, that are stored in DigitalOcean Spaces.