<commit_before>docker-backup-to-s3
===================

Docker container that backups files to Amazon S3<commit_msg>README updated<commit_after>Docker Backup to Amazon S3
===================

Docker container that backups files to Amazon S3 using [s3cmd sync](http://s3tools.org/s3cmd-sync). It doesn't upload files that has already been uploaded to S3. Upload happens once per day at noon.

### Usage

	docker run -d [OPTIONS] istepanov/backup-to-s3

### Options:

* `-e ACCESS_KEY=<AWS_KEY>`: Your AWS key. Required.
* `-e SECRET_KEY=<AWS_SECRET>`: Your AWS secret. Required.
* `-e S3_PATH=s3://<BUCKET_NAME>/<PATH>/`: S3 Bucket name and path. Should end with trailing slash. Required.
* `-e DATA_PATH=/data/`: container's data folder. Default is `/data/`. Should end with trailing slash. Optional.  
*  `-v /path/to/backup:/data:ro`: mount target local folder to container's data folder. Required.

### Example:

    docker run -d && \
    	-e ACCESS_KEY=fakeawskey
		-e SECRET_KEY=fakeawssecret
		-e S3_PATH=s3://my-bucket/backup/
		-v /home/user/data:/data:ro
		istepanov/backup-to-s3
{'fraction_non_alphanumeric': 0.1588613406795225, 'fraction_numerical': 0.013774104683195593, 'mean_word_length': 4.023041474654378, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '693514', 'n_tokens_mistral': 400, 'n_tokens_neox': 373, 'n_words': 113}