Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Instructions to set up public access to S3 #86

Merged
merged 3 commits into from
Mar 9, 2017

Conversation

RobinDaugherty
Copy link
Contributor

@RobinDaugherty RobinDaugherty commented Mar 6, 2017

  • More specific instructions on how to set up S3 access to the deployment process.
  • Example policy to allow outside access to the S3 bucket.
  • Improved formatting and fixed a syntax issue.

The existing documentation included some details on the policy object to provide access to the deployment script, but it seemed a little ambiguous. I added some wording to make it obvious that the deployment script needs to have its own user with Put permission to the bucket, and that the policy should be applied to that user account.

I added an example policy to help someone provide access to the S3 bucket so that they can serve the assets to users on the web.

The existing policy included < and > around the example string that should be replaced, but this didn't really make it stand out, and the text explaining that it needs to be replaced wasn't being formatted correctly (it looked like an HTML tag, so it was either being suppressed by Github's markdown-to-HTML processor).

@RobinDaugherty RobinDaugherty changed the title Provide instructions for public access to S3 Instructions to set up public access to S3 Mar 6, 2017
README.md Outdated

Ensure you have the minimum required permissions configured for the user (accessKeyId). A bare minimum policy should have the following permissions:
The environment in which the `ember deploy` command is run (outside of development) needs to have an AWS account with a policy that allows writing to the S3 bucket.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the only note I'd make here is to remove (outside of development), I believe that especially in early stages a lot of people will deploy from their own laptop so I think this could be confusing

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. I've reworded this to be more clear.

README.md Outdated

Ensure you have the minimum required permissions configured for the user (accessKeyId). A bare minimum policy should have the following permissions:
The environment in which the `ember deploy` command is run (outside of development) needs to have an AWS account with a policy that allows writing to the S3 bucket.
The best way to do this is to create an IAM user to be the "deployer", and place its security credentials (Access Key ID and Access Secret) in the environment on the server or CI environment where deployment takes place.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe replace server with machine to address the concern I was expressing above? (open to suggestions on wording)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I was struggling with "server" vs "machine". I changed it to "machine", I think it makes sense.

@ghedamat
Copy link
Contributor

ghedamat commented Mar 9, 2017

hi @RobinDaugherty, thanks a lot for this! it looks great

I just made a couple of tiny notes, let me know what you think!

@ghedamat
Copy link
Contributor

ghedamat commented Mar 9, 2017

@RobinDaugherty this looks great
one last request

could you squash the commits?

thanks again!

@ghedamat
Copy link
Contributor

ghedamat commented Mar 9, 2017

nevermind! I can do it here :D

I always forget

@ghedamat ghedamat merged commit 923b1b3 into ember-cli-deploy:master Mar 9, 2017
@RobinDaugherty RobinDaugherty deleted the patch-1 branch March 10, 2017 17:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants