server_backups 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0acb87133c33b34ff515fff6e6186f91ac5717a8
+  data.tar.gz: 1d4086a756cdf6310058763f9ca159698321dfa0
+SHA512:
+  metadata.gz: d4e18e316446d6b8e9ee132f1b723130993e9d05cc9f862b5fa86c16f7c621ba15d985f47632c1d3cb955054cd91896140a7091ed60c3a0dde169b5b42416dfa
+  data.tar.gz: aff7a18c7cb285f6d55fc9d1a50e9dea83524667943ea301c8cbd645b23a546de3fced372cdff33f6b7732ff5c7ab0771235b8507f6417b9b4c2433547ad1c78

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem
+.vscode/settings.json

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_from: .rubocop_todo.yml
+
+# inherit_from: .rubocop_todo.yml
+
+Layout/IndentationWidth:
+  Width: 4
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,35 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-03-30 15:34:28 +0700 using RuboCop version 0.54.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 69
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 110
+
+# Offense count: 1
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 102
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 1
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: io, id, to
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - 'bin/server_backup'

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tgannon@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in server_backups.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    server_backups (0.1.8)
+      activesupport (~> 5.1)
+      aws-sdk-s3 (~> 1.8)
+      main (~> 6.2)
+      slack-notifier (~> 2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    arrayfields (4.9.2)
+    aws-partitions (1.73.0)
+    aws-sdk-core (3.17.1)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.5.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sdk-s3 (1.8.2)
+      aws-sdk-core (~> 3)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.0)
+    aws-sigv4 (1.0.2)
+    chronic (0.10.2)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    fattr (2.4.0)
+    hashdiff (0.3.7)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.3.1)
+    main (6.2.2)
+      arrayfields (~> 4.7, >= 4.7.4)
+      chronic (~> 0.6, >= 0.6.2)
+      fattr (~> 2.2, >= 2.2.0)
+      map (~> 6.1, >= 6.1.0)
+    map (6.6.0)
+    minitest (5.11.3)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    slack-notifier (2.3.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    vcr (4.0.0)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.5)
+  rspec (~> 3.0)
+  server_backups!
+  vcr (~> 4.0)
+  webmock (~> 3.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tyler Gannon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,167 @@
+# Backup Website and Mysql databases to S3
+
+Automated backup and recovery solution capable of restoring files and databases
+to a given point in time.
+
+* Incremental backups of files using [GNU Tar](https://www.gnu.org/software/tar/)
+* Incremental backups of databases using binary logging
+* Files are stored in a structured manner within an Amazon S3 bucket using
+[AWS S3 SDK gem](https://github.com/aws/aws-sdk-ruby)
+
+**Key assumptions made:**
+
+* All databases except system databases will be backed up.
+* Mysql database only.
+* Mysql binary logging is turned on.
+* The **GNU** (not BSD) version of _tar_.  The GNU version includes --listed-incremental, which is needed for incremental backups.
+
+## Installation
+
+Download the installation package from https://gitlab.com/zigzagau/server_backups/tags
+Find the latest tag and download server_backups-0.x.x.gem from there.
+Copy that file to your server.
+
+### Ubuntu
+
+```bash
+
+sudo apt install ruby ruby-dev zlib1g-dev
+sudo gem install server_backups-0.x.x.gem
+
+```
+
+### Configure Mysql Bin Logging
+
+Add the following to your `my.cnf`, or on Ubuntu you might want to add it to `/etc/mysql/mysql.conf.d/mysqld.conf`
+```
+[mysqld]
+...
+server-id               = 1     # Set it nicely if using replication
+log_bin                 = /var/log/mysql/mysql-bin.log   #  Or your favorite location
+
+```
+
+Then restart mysql:
+
+```
+sudo service mysql restart
+```
+
+### Grant user read access to mysql binary logs and also to your web root
+
+```bash
+# Make sure you know what the group ownership is, for your web root.
+sudo usermod -a -G www-data ubuntu
+sudo usermod -a -G mysql ubuntu
+```
+
+### 
+
+## Usage
+
+### Set up a configuration file
+
+Copy `backup_conf.sample.yml` to `~/.backup_conf.yml` and edit the settings.
+Alternatively you can put the file anywhere, and then specify the path to the file
+using the `-c` parameter.
+
+### Set up your crontab.  
+
+* Use `crontab -e` to edit cron configuration.
+
+**Sample Crontab configuration**
+
+```
+
+# Once per month:
+3 0 1 * * /usr/local/bin/server_backup monthly
+# Once per week:
+5 0 * * 0 /usr/local/bin/server_backup weekly
+# Once per day:
+5 0 *  * 1-6 /usr/local/bin/server_backup daily
+# And incremental backups once per hour
+5 1-23 * * * /usr/local/bin/server_backup incremental
+
+```
+
+### Command line parameters
+
+#### 1) For taking backups:
+
+some examples
+
+```bash
+# Take a full backup and store it in the monthly backups location.
+server_backup monthly
+
+# Take a full backup as normal, but instead of backing up all databases,
+# only back up `mydatabase`.
+server_backup daily -d mydatabase
+
+server_backup daily -f  # only back up the files, not the database(s)
+server_backup daily -b  # only back up the database(s), not the files
+
+# Take an incremental backup, but load the given configuration file.
+server_backup incremental -c /etc/my_backup_configuration.cnf
+
+```
+
+#### 2) List (or search) time zones for help with configuration
+
+```bash
+server_backup zones  # list all
+server_backup zones america  # case insensitive search for zones containing a string
+```
+
+#### 3) Restore backups
+
+```bash
+# Restore up to the latest backup data available on s3
+server_backlup restore
+
+# Restore up to two days ago at 3pm in the configured
+# time zone (see config file).
+server_backup restore --up_to='two days ago at 3:00 PM'
+
+# To make it easier to decide what time your restore point
+# should be, you can write the restore point time in any time
+# zone and it will be translated to the server's normal time zone.
+#
+# This way, if the server is in UTC and you're in Singapore, you
+# don't necessarily have to do any confusing time maths in order
+# to restore back to what time it was before you made a mistake
+# and updated a wordpress plugin.  ;)
+server_backup restore --up_to='March 28 12:00 PM' --time_zone='Singapore'
+
+``` 
+
+```
+NAME
+  server_backup
+
+SYNOPSIS
+  server_backup (restore|zones) backup_type [options]+
+
+PARAMETERS
+  backup_type (1 -> symbol(backup_type))
+      specifies the backup type to perform [incremental | daily | weekly |
+      monthly]
+  --config=config, -c (0 ~> config=~/.backup_conf.yml)
+      load configuration from YAML file
+  --database=database, -d (default ~> database=all)
+      Which database to back up, defaults to all non-system databases.
+  --db_only, -b (default ~> false)
+      If specified
+  --files_only=[files_only], -f (de ~> files_only)
+      Only work with files.
+  --help, -h
+```
+
+### Restore your application
+
+```bash
+website_backup restore app_name
+```
+
+
+* Everything in /var/www 

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/backup_conf.sample.yml

@@ -0,0 +1,82 @@
+###############################################################################
+# 
+#                  Sample Backup Configuration
+# 
+# 
+# 
+###############################################################################
+
+logging:
+    # DEBUG, INFO, WARN, ERROR, FATAL
+    log_threshold: 'DEBUG'
+    # If set to true, logs to STDOUT and all the subsequent settings in this
+    # section will be ignored.
+    use_stdout: true
+    logfile_path: '/tmp/server_backup.log'
+    keep_files: 1
+    file_size:
+        kilobytes: 100
+
+# Optional.  Defaults to /var/www
+file_location: 'spec/fixtures/www'
+# The time zone that you'd like backups to be kept in.
+# Backup files will be named with a timestamp located in the given timezone.
+time_zone: 'Singapore'
+# Optional.  Will attempt to determine from operating system
+# defaults to the value of the `time_zone` property above.
+system_time_zone: 'Asia/Ho_Chi_Minh'
+
+slack: 
+  # Set up a new webhook at https://slack.com/apps/A0F7XDUAZ-incoming-webhooks
+  # Once configured, put the address here.
+  webhook: https://hooks.slack.com/services/asdasdasdasdasdasdasdasdasdasd
+  # If you want to babysit your backups, set this true.
+  notify_on_success: true
+  # A list of user ids of persons to @mention when posting success messages.
+  mention_users_on_failure:
+    - U9ASDFASD
+    # - U8SXDFG34
+    # - U23SDU3LD
+    # - U3234ASD4
+  # Leave empty for none.
+  mention_users_on_success:
+    - U9ASDFASD
+
+retention:
+  incremental:
+    hours: 144
+  daily:
+    days: 6
+  weekly:
+    weeks: 3
+  monthly:
+    months: 11
+
+mysql:
+  # Database to back up
+  database:
+  # MySql credentials
+  user: root
+  password:
+  # Path (with trailing slash) to mysql commands e.g. mysqldump
+  bin_path: /usr/local/bin/
+  # If you are using MySql binary logging:
+  # Path to the binary logs, should match the log_bin option in your my.cnf.
+  # Comment out if you are not using mysql binary logging
+  bin_log: /var/tmp/mysql-bin
+
+s3:
+  # S3 credentials
+  access_key_id: ASDFASDFASDFASDFASDF
+  secret_access_key: asdfasdfasdfasdfasdfasdfasdfasdfasdfasdf
+  # Bucket in which to store your backups
+  # # Bucket in which to store your backups
+  bucket: myapp-backup-test
+
+  # The prefix under which to store and retrieve backups for this server
+  #  e.g. my_app_name
+  prefix: my_test_app
+
+  # AWS region your bucket lives in.
+  # (I suspect you only need to specify this when your 'location' is in a different region.)
+  region: ap-southeast-1

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'server_backups'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)