synco 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2220364fdaf5ff681db98ef502f6ba6cf3564a126881f4836f99c900a11c2683
-  data.tar.gz: 0e540bde6b6037f01a2d1afde4e7625e053d548a5ee2abfb773f7338767bb893
+  metadata.gz: 42343f27c1a3ff659177999629a756000e4c5ced7b6474872ca5a0917d854f8e
+  data.tar.gz: dca509a5620feadc9479dcb0ae2d6e30eae6b4eb13bb093b7d986731d760a9f0
 SHA512:
-  metadata.gz: 2c19fc3258b7fa09c588c29161d184783d334e6e9454ef7c9b202c9ae5bc0fb7fe0755a4f2ed9313359e1411e6848b42c619a5a273d1cbdb385ccb2a6f4b6805
-  data.tar.gz: 1d9dde6a44640464d8651ebce01acbdadcb470139e665c15985cb10172e1cd47467ad1ec2cb700fcdf9506ba8e4e6e03122f716193c8a039d4bb9e10dcc69b72
+  metadata.gz: 36215207716af1b46eebb94f2a6515d0d67fa5ecec8d85d8106eef5664ba74a3a294fcab277becf56a30d73d180d63e1b9a528f881774bb0c53ddd66408aa595
+  data.tar.gz: bcbdd5a44feaa92e3898b167718b4f798abbc614579ff94897b91dfebaec472ee1f99e49dedb42704da3b296b57fc82ca3a2051429ee57fc151220cd0119935b

data/lib/synco/command.rb

@@ -47,7 +47,7 @@ module Synco
 				if @options[:version]
 					puts "synco v#{Synco::VERSION}"
 				elsif @options[:help] or @command.nil?
-					print_usage(program_name)
+					print_usage
 				else
 					chdir do
 						@command.call

data/lib/synco/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2008-2024, by Samuel Williams.
 
 module Synco
-	VERSION = "1.3.0"
+	VERSION = "1.3.1"
 end

data/readme.md

@@ -1,6 +1,6 @@
-# Synco ![Development](https://github.com/ioquatix/synco/workflows/Development/badge.svg)
+# Synco
 
-Synco is a tool for scripted synchronization and backups. It provides a custom Ruby DSL for describing backup and synchronization tasks involving one more more system and disk. It is designed to provide flexibility while reducing the complexity multi-server backups.
+Synco is a tool for scripted synchronization and backups. It provides a custom Ruby domain specific language (DSL) for describing backup and synchronization tasks involving one more more system and disk. It is designed to provide flexibility while reducing the complexity multi-server backups.
 
   - Single and multi-server data synchronization.
   - Incremental backups both locally and remotely.
@@ -10,224 +10,15 @@ Synco is a tool for scripted synchronization and backups. It provides a custom R
 
 [![Development Status](https://github.com/ioquatix/synco/workflows/Test/badge.svg)](https://github.com/ioquatix/synco/actions?workflow=Test)
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'synco'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install synco
-
 ## Usage
 
-Synco imposes a particular structure regarding the organisation of backup scripts: Backup scripts involve a set of servers and directories. A server is a logical unit where files are available or stored. Directories are relative paths which are resolved relative to a server's root path.
-
-A simple backup script might look something like this:
-
-``` ruby
-#!/usr/bin/env ruby
-
-require 'synco'
-require 'synco/methods/rsync'
-
-Synco::run_script do |script|
-	script.method = Synco::Methods::RSync.new(archive: true)
-	
-	server(:master) do |server|
-		server.host = "server.example.com"
-		server.root = "/"
-	end
-	
-	server(:backup) do |server|
-		server.host = "backup.example.com"
-		server.root = "/tank/backups/server.example.com"
-	end
-	
-	backup('etc', 'var', 'srv', 'home', 
-		arguments: %W{--exclude cache/ --exclude tmp/}
-	)
-end
-```
-
-This will produce an identical copy using rsync of the specified directories. As an example `server.example.com:/etc` would be copied to `backup.example.com:/tank/backups/server.example.com/etc`.
-
-### RSync Snapshots
-
-Building on the above backup, you can use `Synco::Methods::RSyncSnapshot` which supports snapshot based backups. It creates a snapshot into a sub-directory called `latest.snapshot` and uses RSync's `--link-dest` to hard-link files when unchanged. Synco provides scripts to rotate and prune these backups as required, but you must invoke them as part of the script:
-
-``` ruby
-server(:backup) do |server|
-	server.host = "backup.example.com"
-	server.root = "/"
-	
-	server.on(:success) do
-		run "synco", "rotate", chdir: target_server.root
-		run "synco", "prune", chdir: target_server.root
-	end
-end
-```
-
-These commands can also be run from the command line.
-
-``` 
-rotate [--format <name>] [--latest <name>] [--snapshot <name>]
-	Rotate a backup snapshot into a timestamped directory.
-
-	[--format <name>]    Set the name of the backup rotations, including strftime expansions.  Default: %Y.%m.%d-%H.%M.%S
-	[--latest <name>]    The name of the latest backup symlink.                                Default: latest           
-	[--snapshot <name>]  The name of the in-progress backup snapshot.                          Default: latest.snapshot  
-
-prune [--hourly <count>] [--daily <count>] [--weekly <count>] [--monthly <count>] [--quarterly <count>] [--yearly <count>] [--format <name>] [--latest <name>] [--keep <new|old>] [--dry]
-	Prune old backups to reduce disk usage according to a given policy.
-
-	[--hourly <count>]     Set the number of hourly backups to keep.                             Default: 24               
-	[--daily <count>]      Set the number of daily backups to keep.                              Default: 28               
-	[--weekly <count>]     Set the number of weekly backups to keep.                             Default: 52               
-	[--monthly <count>]    Set the number of monthly backups to keep.                            Default: 36               
-	[--quarterly <count>]  Set the number of quaterly backups to keep.                           Default: 40               
-	[--yearly <count>]     Set the number of yearly backups to keep.                             Default: 20               
-	[--format <name>]      Set the name of the backup rotations, including strftime expansions.  Default: %Y.%m.%d-%H.%M.%S
-	[--latest <name>]      The name of the latest backup symlink.                                Default: latest           
-	[--keep <new|old>]     Keep the younger or older backups within the same period division     Default: old              
-	[--dry]                Print out what would be done rather than doing it.                  
-```
-
-### Mounting Disks
-
-Synco supports mounting disks before the backup begins and unmounting them after done. The specifics of this process may require some adjustment based on your OS. For example on linux, `sudo` is used to invoke `mount` and `umount`.
-
-``` ruby
-server(:destination) do |server|
-	self.mountpoint = '/mnt/backups'
-	self.root = File.join(server.mountpoint, 'laptop')
-	
-	server.on(:prepare) do
-		# synco mount uses labels, e.g. the disk partition has LABEL=backups
-		target_server.run "synco", "mount", target_server.mountpoint, 'backups'
-	end
-	
-	server.on(:finish) do
-		target_server.run "synco", "unmount", target_server.mountpoint
-	end
-end
-```
-
-On Linux, you might want to create the file `/etc/sudoers.d/synco` with the following contents:
-
-    %wheel ALL=(root) NOPASSWD: /bin/mount
-    %wheel ALL=(root) NOPASSWD: /bin/umount
-
-Please make sure you take the time to educate yourself on the security of such a setup.
-
-### Database Backups
-
-If you'd like to dump data before running the backup, it's possible using the event handling mechanisms:
-
-``` ruby
-server(:master) do |server|
-	server.host = "server.example.com"
-	server.root = "/"
-	
-	server.on(:prepare) do
-		# Dump MySQL to /srv/mysql
-		run '/etc/lsync/mysql-backup.sh'
-	end
-end
-```
-
-The exact contents of `mysql-backup.sh` will depend on your requirements, but here is an example:
-
-``` bash
-#!/usr/bin/env bash
-
-BACKUP_DIR=/srv/mysql
-MYSQL=/usr/bin/mysql
-MYSQLDUMP=/usr/bin/mysqldump
-
-databases=`mysql --user=backup -e "SHOW DATABASES;" | grep -Ev "(Database|information_schema|performance_schema|_test|_restore)"`
-
-# http://stackoverflow.com/questions/451404/how-to-obtain-a-correct-dump-using-mysqldump-and-single-transaction-when-ddl-is
-MYSQLDUMP_OPTIONS="--force --skip-opt --single-transaction --add-drop-table --create-options --quick --extended-insert --set-charset --disable-keys"
-
-for db in $databases; do
-	echo "Dumping database $db to $BACKUP_DIR/$db.sql.xz..."
-	mysqldump --user=backup $MYSQLDUMP_OPTIONS --databases $db | xz > "$BACKUP_DIR/$db.sql.xz"
-done
-```
-
-### Fingerprint Integration
-
-It is possible to make a [cryptographic checksum of the data](https://github.com/ioquatix/fingerprint). On a filesystem that support immutable snapshots, you can do this before the data is copied. For traditional filesystems, you generally need to do this afterwards.
-
-``` ruby
-server(:master) do |server|
-	server.host = "server.example.com"
-	server.root = "/"
-	
-	server.on(:success) do
-		# Run fingerprint on the backup data:
-		run 'fingerprint', '--root', target_server.root, 'analyze'
-	end
-end
-```
-
-Fingerprint is used in many of the specs to verify file copies.
-
-### ZFS Snapshots
-
-*This part of Synco is still under heavy development*
-
-Synco can manage synchronization and backups of ZFS partitions. However, to use the standard tools, it is necessary to enable `zfs_admin_snapshot`, in `/etc/modprobe.d/zfs.conf`:
-
-    options zfs zfs_admin_snapshot=1
-
-Propagate user permissions for the ZFS partition:
-
-``` bash
-sudo zfs allow -ld -u `whoami` create,mount,send,receive,snapshot tank/test
-```
-
-### Backup staging
-
-Synco in a previous life supported backup staging. However, at this time it's not available except in a very limited form: backup scripts which use `Synco.run_script` use explicit locking so that it's not possible to run the same backup at the same time. In the future, staging sequential and parallel backups will be added.
-
-### DNS Failover
-
-**This behaviour is not well tested**
-
-Synco uses DNS to resolve the master server. This allows for bi-directional synchronization and other interesting setups.
-
-Firstly, a backup script defaults to the server with the name `:master` as the master, where data is replicated FROM.
+Please see the [project documentation](https://ioquatix.github.io/synco/) for more details.
 
-However, it is possible instead to specify a hostname, e.g. `primary.example.com`. Then, specify several servers, e.g. `s01.example.com`, `s02.example.com` and so on:
+  - [Getting Started](https://ioquatix.github.io/synco/guides/getting-started/index) - This guide gives an overview of Synco, how to install it how to use it to backup and replicate data.
 
-``` ruby
-Synco::run_script do |script|
-	script.method = Synco::Methods::RSync.new(archive: true)
-	
-	script.master = "primary.example.com"
-	
-	server("s01.example.com") do |server|
-		server.root = "/"
-	end
-	
-	server("s02.example.com") do |server|
-		server.root = "/"
-	end
-	
-	backup('srv/http', 
-		arguments: %W{--exclude cache/ --exclude tmp/}
-	)
-end
-```
+  - [Backup Policy](https://ioquatix.github.io/synco/guides/backup-policy/index) - This guide provides an overview of a Digital Information Backup Policy, including the main concerns affecting data retention and backup, the specific details that need to be considered, and the hardware and software solutions available to match your exact requirements.
 
-When you run the script, the behaviour will depend on whether `primary.example.com` points to `s01.example.com` or `s02.example.com`. The data will always be copied from the master server to the other servers.
+  - [Backup Script](https://ioquatix.github.io/synco/guides/backup-script/index) - This guide explains how to create a backup script and the various options available to you.
 
 ## Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synco
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -170,6 +170,7 @@ homepage: https://github.com/ioquatix/synco
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://ioquatix.github.io/synco/
   funding_uri: https://github.com/sponsors/ioquatix/
   source_code_uri: https://github.com/ioquatix/synco.git
 post_install_message: