Add example config for syncing with an AWS S3 bucket #463
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It requires the official AWS CLI to be available, and that credentials be set up through some external method, such as environment variables, IAM profiles, the AWS SDK configuratin. The AWS CLI sync exclude rules are not as powerful as the ones supported by lsyncd. Hence, some of the do not translate perfectly. For example, '*' (asterisk) matches slashes, while it does not in lsyncd. Hence it is a good idea to only use exclude patterns for full directories, either by using a trailing / (slash) or ** (double asterisk), as those will be correctly translated. An initialSync options is provided as a convenience, since it's not easy to make sure exclusion rules match when doing it manually. It will *pull* from the target bucket to the local dir (the opposite of the regular behavior) then exit immediately.
Collaborator
|
Interesting, can you please add authorship (name and email) information to the file? Since I don't know anything about AWS gives people a place to contact if they have an issue, things need updating etc. |
Contributor
Author
|
@axkibe Done! |
Collaborator
|
Okay, thank you, merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It requires the official AWS CLI to be available, and that credentials
be set up through some external method, such as environment variables,
IAM profiles, the AWS SDK configuratin.
The AWS CLI sync exclude rules are not as powerful as the ones supported by
lsyncd. Hence, some of the do not translate perfectly. For example, '*'
(asterisk) matches slashes, while it does not in lsyncd. Hence it is a good
idea to only use exclude patterns for full directories, either by using a
trailing / (slash) or ** (double asterisk), as those will be correctly
translated.
An initialSync options is provided as a convenience, since it's not easy to
make sure exclusion rules match when doing it manually. It will pull from
the target bucket to the local dir (the opposite of the regular behavior)
then exit immediately.