Storage Configuration

For image and volume data uploads, neuron-catalog depends on an the Amazon Simple Storage Service or a compatible provider. Under the hood, this support is provided by Meteor Slingshot.

Configuration of Amazon Web Services

You need to setup and configure this to run your own instance of neuron-catalog.

Create an AWS user and login to the AWS Console.
Create an S3 Bucket.
In the bucket permissions, add the following CORS configuration:

<?xml version="1.0" encoding="UTF-8"?>
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <CORSRule>
        <AllowedOrigin>*</AllowedOrigin>
        <AllowedMethod>PUT</AllowedMethod>
        <AllowedMethod>POST</AllowedMethod>
        <AllowedMethod>GET</AllowedMethod>
        <AllowedMethod>HEAD</AllowedMethod>
        <MaxAgeSeconds>3000</MaxAgeSeconds>
        <AllowedHeader>*</AllowedHeader>
    </CORSRule>
</CORSConfiguration>

Enable static website hosting for this S3 bucket by selecting Enable website hosting in the AWS Console. Also set "Index Document" to index.html.
Set the bucket policy to (substitute the name of your bucket for your-bucket-name):

   
{
    "Version": "2008-10-17",
    "Statement": [
        {
            "Sid": "AllowPublicRead",
            "Effect": "Allow",
            "Principal": {
                "AWS": "*"
            },
            "Action": "s3:GetObject",
            "Resource": "arn:aws:s3:::your-bucket-name/*"
        }
    ]
}

In the Identity & Access Management (IAM) configuration, create a user and group for performing the uploads. Note the Access Key and the Secret Key - you will need to enter these.
Still in IAM, set the group policy to the following (again, substitute the name of your bucket for your-bucket-name):

    
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "Stmt1410709913000",
      "Effect": "Allow",
      "Action": [
        "s3:*"
      ],
      "Resource": [
        "arn:aws:s3:::your-bucket-name"
      ]
    },
    {
      "Sid": "Stmt1410710014000",
      "Effect": "Allow",
      "Action": [
        "s3:*"
      ],
      "Resource": [
        "arn:aws:s3:::your-bucket-name/*"
      ]
    }
  ]
}

Now, you need to tell neuron-catalog what your IAM Access Key and Secret Key created above. Please see the settings documentation.