https://github.com/aristotelesbr/keepbox-ruby
Client to sync folder to AWS S3
https://github.com/aristotelesbr/keepbox-ruby
aws-s3 dropbox google-driver
Last synced: over 1 year ago
JSON representation
Client to sync folder to AWS S3
- Host: GitHub
- URL: https://github.com/aristotelesbr/keepbox-ruby
- Owner: aristotelesbr
- Created: 2023-01-04T16:24:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-27T12:03:08.000Z (over 3 years ago)
- Last Synced: 2025-01-17T05:28:16.465Z (over 1 year ago)
- Topics: aws-s3, dropbox, google-driver
- Language: Ruby
- Homepage:
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# keepbox-ruby
Keepbox is a simple, secure, and private way to store and share files. It's a great alternative to Dropbox, Google Drive, and other file sharing services.
It syncs files from a local directory to an Amazon S3 bucket. It's a simple Ruby script that uses the AWS SDK for Ruby. Good for individuals and small teams. God bye Dropbox! 👋 🚀 🚀 🚀
## Installation
Clone the repository and run the following commands:
```bash
bundle install
```
And turn keepbox.rb on executable:
```bash
chmod +x keepbox.rb
```
## Configuration
Export AWS credentials as environment variables:
```bash
export AWS_ACCESS_KEY_ID=YOUR_AWS_ACCESS_KEY_ID
export AWS_SECRET_ACCESS_KEY=YOUR_AWS_SECRET_ACCESS_KEY
```
And your bucket name and prefix folder to store files:
```bash
export BUCKET=YOUR_AWS_BUCKET
export PREFIX=YOUR_AWS_PREFIX
```
You can also use `env-example` in the root directory to create a `.env` file with your credentials.
## Run tests
Run the following command to run the tests:
```bash
bundle exec rake test
```
## Usage
Choice a directory to monitor and run keepbox.rb:
```bash
./keepbox.rb /path/to/your/directory
```
And that's it! 🎉 🎉 🎉
## Contributing
Bug reports and pull requests are welcome on GitHub at.
## License
MIT License - see LICENSE.md for details
☕️