{"id":21526353,"url":"https://github.com/scderox/simple-directory-to-s3-backup","last_synced_at":"2025-03-17T18:34:13.396Z","repository":{"id":134048008,"uuid":"385967956","full_name":"SCDerox/simple-directory-to-s3-backup","owner":"SCDerox","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-29T13:33:48.000Z","size":30,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-24T05:41:45.839Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"wtfpl","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SCDerox.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-14T14:24:09.000Z","updated_at":"2024-10-29T13:33:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"fe481477-46cc-4872-8ab9-25ea534f0c62","html_url":"https://github.com/SCDerox/simple-directory-to-s3-backup","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDerox%2Fsimple-directory-to-s3-backup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDerox%2Fsimple-directory-to-s3-backup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDerox%2Fsimple-directory-to-s3-backup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDerox%2Fsimple-directory-to-s3-backup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SCDerox","download_url":"https://codeload.github.com/SCDerox/simple-directory-to-s3-backup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244089349,"owners_count":20396239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T01:44:41.907Z","updated_at":"2025-03-17T18:34:13.375Z","avatar_url":"https://github.com/SCDerox.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Simple directory to S3 \n## Features\n* This system will backup folders and upload them to your s3 bucket\n* Every backup is encrypted using the ZIP encryption algorithm\n* Backups can automatically done every hour\n* Backups can automatically be deleted from your S3-Bucket every x days\n\n## Should I use this?\nProbably not tbh. It's quite complicated to set up, and the project only hase a very small and specific use-case. \n`Why is it called \"Simple..\" if it's complicated to set up? ~ I am very glad you asked, it's because the code is quite simple and it took not a very long time to develop this \"thing\".`\n\n## Installation\nMake sure you have `zip` installed on your system: `apt install zip`.\n\n1. Clone this repo: `git clone https://github.com/SCDerox/simple-directory-to-s3-backup.git`\n2. Install dependencies `npm ci`\n3. Set up a S3-Bucket on AWS\n4. Create a configuration-file called `config.json` in the cloned directory and change the configured parameters (\n   explained below).\n5. Then start the script as described below. \n\n## Start the system\n* If you only want to back up once run `npm start` in the cloned directory\n* To ensure that backups are performed hourly, I suggest to use [pm2](https://pm2.keymetrics.io/): `pm2 start index.js`\n\n## Configure\nYou can change these parameters in the `config.json` you created earlier.\n* `key`: Password with which the ZIP should be encrypted\n* `prefix`: Optional prefix which should be put before every filenname\n* `path`: Path on your S3-Bucket in which the backup should be saved\n* `enabledHourlyUpload`: If enabled the script will backup your files hourly\n* `limitHoursTo`: Array of strings; Hours to limit the hourly upload to\n* `folders`: Array of the following paths that should get backed up\n* `runCommandsBeforeExecution`: Array of commands to run before execution (for example `mysqldump`or something)\n* `bucketID`: ID of your S3-Bucket\n* `accessKeyID`: ID of your access-key\n* `bucketRegion`: Region of your bucket\n* `secretAccessKey`: Secret of your access-key\n* `deleteItems`: If enabled, S3 objects will be deleted automatically (in the specified folder) if they are older than\n  `daysBeforeDeletion`. We suggest using lifecycle rules is supported by your S3 provider.\n* `doNotDeleteLocalBackup`: By default local backup files will be deleted after they have been uploaded. Enable this\n  option do disable this behavior.\n\n\n## How do I decrypt the encrypted file?\n\nUse `unzip \u003cFileName\u003e` to unzip your file. You'll be asked for a password when decrypting.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscderox%2Fsimple-directory-to-s3-backup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscderox%2Fsimple-directory-to-s3-backup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscderox%2Fsimple-directory-to-s3-backup/lists"}