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

Readme was improved. #2

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ that are otherwise encumbered.
Signed by git commit adding my legal name and git username:

Written in 2018 by David E. Jones - jonesde
Written in 2020 by Tatiana Mitioglova - thaiwan

===========================================================================

Expand All @@ -57,4 +58,5 @@ litigation is filed.
Signed by git commit adding my legal name and git username:

Written in 2018 by David E. Jones - jonesde
Written in 2020 by Tatiana Mitioglova - thaiwan

17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
# Moqui AWS Integrations

Amazon Web Services tool integrations for Moqui Framework

* In order to work with AWS, you must have an AWS account.
For security purposes create IAM user with administrator access instead of using just your root user.
More information about creating a user can be found [here](https://docs.aws.amazon.com/mediapackage/latest/ug/setting-up-create-iam-user.html)

* Create an S3 bucket with policies that allow you to upload data.

* To add moqui-aws component to Moqui simply clone this repository in your-moqui-project-name/runtime/component folder
or use the command ./gradlew getComponent -Pcomponent=moqui-aws.

* Add your credentials at moqui-aws/MoquiConf.xml file.
You can check your region code [here](https://docs.aws.amazon.com/general/latest/gr/rande.html).

* Run your moqui app. To be able to save in the AWS S3 bucket go to System -> User groups and choose ALL_USERS group.
At the Preferences section for the keys **mantle.content.large.root** and **mantle.content.root** set the values "aws3://your-bucket-name".

* After applying these settings your S3 bucket will be a data storage house for your application.