megasync/README.md

49 lines
925 B
Markdown
Raw Normal View History

2020-06-07 11:39:56 +00:00
# megasync
2020-06-07 11:50:01 +00:00
Run [mega-sync](https://mega.nz/sync) as a Docker image
2020-06-07 11:39:56 +00:00
## Features
2020-06-07 11:50:01 +00:00
* Keeps your MEGASync directory in your Mega account in sync with the `/home/mega` directory in the container
2020-06-07 11:39:56 +00:00
2020-06-07 11:50:01 +00:00
## Usage
2020-06-07 11:39:56 +00:00
```
2020-06-07 11:50:01 +00:00
docker run -d \
-e EMAIL=YOUR_MEGA_ACCOUNT_EMAIL \
-e PASSWORD=YOUR_MEGA_PASSWORD \
-v /path/to/sync:/home/mega \
docker.cluster.fun/averagemarcus/megasync
```
2020-06-07 11:39:56 +00:00
## Building from source
With Docker:
```sh
make docker-build
```
Standalone:
```sh
make build
```
## Resources
2020-06-07 11:50:01 +00:00
* [mega-sync](https://mega.nz/sync)
* [MEGAcmd](https://github.com/meganz/MEGAcmd)
2020-06-07 11:39:56 +00:00
## Contributing
If you find a bug or have an idea for a new feature please [raise an issue](/AverageMarcus/megasync/issues/new) to discuss it.
Pull requests are welcomed but please try and follow similar code style as the rest of the project and ensure all tests and code checkers are passing.
Thank you 💛
## License
See [LICENSE](LICENSE)