rtbackup 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 212b6a678d4e7dd3153fe755cf6b87a13cbe51a7
-  data.tar.gz: 9f6a0e378d592e3d176cbe43c3c468205c6f678d
+  metadata.gz: 9975ae069942cae2beab8186b5b78a22f23a1b70
+  data.tar.gz: 6556a498a682cdf0da406fe991fd689d76f68c2d
 SHA512:
-  metadata.gz: 37b4351eda5c87677080a75d3ad039f09143fb73e61b39ab1ba957edfc5feb45f08742436c411aa3fd9920ba04fb46353edc6faef4054856190b7e06e90dc9c3
-  data.tar.gz: 637e3a49d44b4a5b1485c150b119b5169c9c9abc37553687760eb7b4c34f3e84bfb0edb41b227eab21820def3daace3f562c197754856e554b50f2bf453d8159
+  metadata.gz: 12e3b1c4abbfcec96872e6eed291396f629687ba4321887e4cfd9276dcb04b1ecd92acc0ceeb8519a2474502aa4fee04608f901019dd47fb3bb9ca503fcd7140
+  data.tar.gz: b67153abaa09eaaa1d46d23cb602e313471ceecdd9c70b76fa116833df24785637a3ab65b59c01cf1e4f259409fbf5e48af4c093368a953630cc7d9a921e4c12

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    server_backups (0.1.21)
+    rtbackup (0.1.21)
       activesupport (~> 5.1)
       aws-sdk-s3 (~> 1.8)
       main (~> 6.2)
@@ -81,7 +81,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   rake (~> 10.5)
   rspec (~> 3.0)
-  server_backups!
+  rtbackup!
   vcr (~> 4.0)
   webmock (~> 3.3)
 

data/README.md

@@ -17,28 +17,46 @@ to a given point in time.
 
 ## 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.
+### Alpine Linux
+
+The following instructions work for Alpine Linux
+
+```bash
+apk add --no-cache ruby ruby-rake ruby-io-console ruby-bigdecimal ruby-json ruby-bundler \
+                   tar gzip zlib zlib-dev dcron tzdata
+
+cat > ~/.gemrc <<EOF
+---
+gem: --no-ri --no-rdoc
+EOF
+
+gem install rtbackup
+
+```
 
 ### Ubuntu
 
 ```bash
 
-sudo apt install ruby ruby-dev zlib1g-dev
-sudo gem install server_backups-0.x.x.gem
+sudo apt-get install -y ruby ruby-dev zlib1g-dev
+sudo gem install rtbackup
 
 ```
 
-### Configure Mysql Bin Logging
+### Configure Mysql Binary Logging
+
+Make sure that binary logging is enabled on your mysql server.  The following settings
+need to be enabled in mysql configuration files.  On Debian-based Linux distros this
+means editing `/etc/mysql/mysql.conf.d/mysqld.cnf`, though Alpine Linux and others will
+involve editing `/etc/mysql/my.cnf`.
 
-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
-
+# ...
+#  Make sure that you know how to use this setting properly if you're using replication.
+server-id               = 1
+log_bin                 = /var/log/mysql/mysql-bin  #  Make sure this matches the
+                                                    #  bin_log setting in your backup_conf.yml file.
 ```
 
 Then restart mysql:
@@ -55,43 +73,46 @@ sudo usermod -a -G www-data ubuntu
 sudo usermod -a -G mysql ubuntu
 ```
 
-###
+## Set up backup_conf.yml
+
+Set up a configuration file with the following command:
 
-## Usage
+```bash
+rtbackup create_config
+```
 
-### Set up a configuration file
+Now edit `~/.backup_conf.yml` and adjust it to fit your app's needs.
 
-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, or even pipe a config file in through stdin.
+## Schedule backups to run.
 
-The latter option is useful if you'd like to keep passwords and keys in variables,
-rather than saving them to the filesystem.
+Schedule your backups by running
 
 ```bash
-envsubst < back_conf.yml.tmpl | server_backup daily -c -
+rtbackup crontab
 ```
 
-### Set up your crontab.
+This will enable the recommended backup schedule:
 
-* Use `crontab -e` to edit cron configuration.
+* Hourly incremental backups from 1am to 11pm
+* Daily full backups at midnight
+* Weekly full backups on Sunday
+* Monthly full backups on the first of the month
 
-**Sample Crontab configuration**
+Full backups are all the same, but their retention periods differ.
 
+Change the schedule by running the command:
+
+```bash
+crontab -e
 ```
 
-# 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
+See the [crontab manual pages](https://linux.die.net/man/5/crontab) or look online for tutorials
+on how to edit cron schedules.
 
-```
+That's all!  Your backups are now scheduled.  You may run `rtbackup daily` in order to get your first
+full backup.
 
-### Command line parameters
+# Command line parameters
 
 #### 1) For taking backups:
 
@@ -99,36 +120,36 @@ some examples
 
 ```bash
 # Take a full backup and store it in the monthly backups location.
-server_backup monthly
+rtbackup monthly
 
 # Take a full backup as normal, but instead of backing up all databases,
 # only back up `mydatabase`.
-server_backup daily -d mydatabase
+rtbackup 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
+rtbackup daily -f  # only back up the files, not the database(s)
+rtbackup 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
+rtbackup 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
+rtbackup zones  # list all
+rtbackup 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_backup restore
+rtbackup 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'
+rtbackup 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
@@ -138,16 +159,16 @@ server_backup restore --up_to='two days ago at 3:00 PM'
 # 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'
+rtbackup restore --up_to='March 28 12:00 PM' --time_zone='Singapore'
 
 ```
 
 ```
 NAME
-  server_backup
+  rtbackup
 
 SYNOPSIS
-  server_backup (restore|zones) backup_type [options]+
+  rtbackup (restore|zones) backup_type [options]+
 
 PARAMETERS
   backup_type (1 -> symbol(backup_type))

data/advanced-configuration.md

@@ -0,0 +1,11 @@
+## Alternate configuration options
+
+Alternatively you can put the file anywhere, and then specify the path to the file
+using the `-c` parameter, or even pipe a config file in through stdin.
+
+The latter option is useful if you'd like to keep passwords and keys in variables,
+rather than saving them to the filesystem.
+
+```bash
+envsubst < back_conf.yml.tmpl | rtbackup daily -c -
+```

data/backup_conf.sample.yml

@@ -1,31 +1,59 @@
 ###############################################################################
 #
-#                  Sample Backup Configuration
-#
-#
+#                  Sample RT Backup Config File
 #
 ###############################################################################
 
+mysql:
+  host: 127.0.0.1
+  # Database to back up
+  database:
+  # MySql credentials
+  user: root
+  password:
+  # Path (with trailing slash) to mysql commands e.g. mysqldump
+  bin_path: /usr/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/lib/mysql/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: mycompany-wpbackups
+
+  # The prefix under which to store and retrieve backups for this server
+  #  e.g. my_app_name
+  prefix: myapp
+
+  # 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-2
+
+  # Optional.  Defaults to /var/www
+file_location: '/var/www/html'
+# 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: 'Sydney'
+# Optional.  Will attempt to determine from operating system
+# defaults to the value of the `time_zone` property above.
+system_time_zone: 'UTC'
+
 logging:
     # DEBUG, INFO, WARN, ERROR, FATAL
-    log_threshold: 'DEBUG'
+    log_threshold: 'WARN'
     # If set to true, logs to STDOUT and all the subsequent settings in this
     # section will be ignored.
-    use_stdout: true
+    use_stdout: ffalse
     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.
@@ -43,41 +71,12 @@ slack:
     - U9ASDFASD
 
 retention:
+  # How many hourly incremental backups to keep
   incremental:
-    hours: 144
+    hours: 48
   daily:
     days: 6
   weekly:
     weeks: 3
   monthly:
     months: 11
-
-mysql:
-  host: 127.0.0.1
-  # 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/rtbackup

@@ -2,10 +2,23 @@
 # frozen_string_literal: true
 
 require 'fileutils'
-
-lib_dir = File.join(File.dirname(__FILE__), '..', 'lib')
+require 'open3'
+this_executable = File.expand_path(__FILE__)
+this_dir = File.expand_path('..', File.dirname(__FILE__))
+lib_dir = File.join(this_dir, 'lib')
 $LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
 
+CRONTAB = <<-EOF
+# Once per month:
+3 0 1 * * #{this_executable} monthly
+# Once per week:
+5 0 * * 0 #{this_executable} weekly
+# Once per day:
+5 0 *  * 1-6 #{this_executable} daily
+# And incremental backups once per hour
+5 1-23 * * * #{this_executable} incremental
+EOF
+
 require 'server_backups'
 require 'main'
 require 'tmpdir'
@@ -133,6 +146,39 @@ Main do
                                        'files_only').values)
         end
     end
+    mode 'crontab' do
+        params[:backup_type].ignore!
+        def run
+            this_executable = File.expand_path(__FILE__)
+            current_crontab, stderr, status = Open3.capture3('crontab -l')
+            if current_crontab =~ Regexp.new(this_executable)
+                puts "Backups appear to be scheduled already."
+                puts "Run crontab -e to modify the schedule, or crontab -l to show it or crontab -r to delete it."
+            else
+                CRONTAB.split("\n").each do |line|
+                    `(crontab -l 2>/dev/null; echo "#{line}") | crontab -`
+                end
+                puts "Backups are scheduled."
+                puts "Run crontab -e to modify the schedule, or crontab -l to show it or crontab -r to delete it."
+            end
+        end
+    end
+
+    mode 'create_config' do
+        params[:backup_type].ignore!
+        def run
+            this_dir = File.expand_path('..', File.dirname(__FILE__))
+            conf_file = File.join(this_dir, 'backup_conf.sample.yml')
+            new_file = File.expand_path("~/.backup_conf.yml")
+            if File.exists?(new_file)
+                puts "#{new_file} already exists.  Please remove it before creating a new one."
+            else
+                FileUtils.copy(conf_file, new_file)
+                puts "I've added a backup configuration file at #{new_file}."
+                puts "Please edit it and make sure that your settings are correct."
+            end
+        end
+    end
 
     mode 'zones' do
         params[:backup_type].ignore!

data/lib/server_backups/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServerBackups
-    VERSION = '0.1.21'
+    VERSION = '0.1.22'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rtbackup
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Tyler Gannon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -156,6 +156,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- advanced-configuration.md
 - backup_conf.sample.yml
 - bin/rtbackup
 - crontab.txt