synco 1.2.0 → 1.3.1

data/lib/synco/methods/scp.rb

@@ -1,30 +1,15 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# frozen_string_literal: true
 
-require_relative '../method'
+# Released under the MIT License.
+# Copyright, 2016-2024, by Samuel Williams.
+
+require_relative "../method"
 
 module Synco
 	module Methods
 		class SCP < Method
 			def default_command
-				['scp', '-pr']
+				["scp", "-pr"]
 			end
 			
 			def call(scope)
@@ -35,10 +20,10 @@ module Synco
 					*@command,
 					*arguments,
 					# If the destination directory already exists, scp will create the source directory inside the destinatio directory. This behaviour means that running scp multiple times gives different results, i.e. the first time it will copy source/* to destination/*, but the second time you will end up with destination/source/*. Putting a dot after the first path alleviates this issue for some reason.
-					scope.master_server.connection_string(directory, on: server) + '.',
+					scope.master_server.connection_string(directory, on: server) + ".",
 					scope.target_server.connection_string(directory, on: server)
 				)
 			end
 		end
 	end
-end
+end

data/lib/synco/methods/zfs.rb

@@ -1,30 +1,15 @@
-# Copyright, 2016, Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# frozen_string_literal: true
 
-require_relative '../method'
+# Released under the MIT License.
+# Copyright, 2016-2024, by Samuel Williams.
+
+require_relative "../method"
 
 module Synco
 	module Methods
 		class ZFS < Method
 			def default_command
-				['zfs', '-rnv']
+				["zfs", "-rnv"]
 			end
 			
 			def call(scope, arguments: [])
@@ -57,4 +42,4 @@ module Synco
 			end
 		end
 	end
-end
+end

data/lib/synco/scope.rb

@@ -1,29 +1,14 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# frozen_string_literal: true
 
-require_relative 'script'
+# Released under the MIT License.
+# Copyright, 2016-2024, by Samuel Williams.
 
-require 'process/group'
+require_relative "script"
 
-require 'console'
-require 'delegate'
+require "process/group"
+
+require "console"
+require "delegate"
 
 module Synco
 	class CommandFailure < RuntimeError
@@ -39,8 +24,6 @@ module Synco
 	end
 	
 	class Runner
-		include Console
-		
 		def initialize(*scripts)
 			@scripts = scripts
 		end
@@ -48,28 +31,26 @@ module Synco
 		attr :scripts
 		
 		def call
-			start_time = Time.now
-			
-			logger.info "===== Starting at #{start_time} ====="
+			Console.info(self, "Running scripts...")
 			
 			Process::Group.wait do |group|
 				@scripts.each do |script|
 					Fiber.new do
-						ScriptScope.new(script, logger, group).call
+						ScriptScope.new(script, group).call
 					end.resume
 				end
 			end
+		rescue => error
+			Console::Event::Failure.for(error).emit(self)
+			raise
 		ensure
-			end_time = Time.now
-			logger.info "[Time]: (#{end_time - start_time}s)."
-			logger.info "===== Finished backup at #{end_time} ====="
+			Console.info(self, "Finished running scripts.")
 		end
 	end
 	
 	class ScriptScope
-		def initialize(script, logger, group)
+		def initialize(script, group)
 			@script = script
-			@logger = logger
 			@group = group
 			
 			@current_server = ServerScope.new(@script.current_server, self)
@@ -77,7 +58,6 @@ module Synco
 		end
 		
 		attr :script
-		attr :logger
 		attr :group
 		attr :master_server
 		attr :current_server
@@ -88,18 +68,17 @@ module Synco
 		
 		def call
 			if @script.running_on_master?
-				logger.info "We are the master server..."
+				Console.info(self, "We are the master server...")
 			else
-				logger.info "We are not the master server..."
-				logger.info "Master server is #{@master}..."
+				Console.info(self, "We are not the master server...", master: @master)
 			end
-
+			
 			@script.try(self) do
 				# This allows events to run on the master server if specified, before running any backups.
 				
 				@master_server.try(master_target_server) do
 					method.try(self) do
-						logger.info "Running backups for server #{@current_server}..."
+						Console.info(self, "Running backups...", server: @current_server)
 						
 						run_servers(group)
 					end
@@ -126,16 +105,15 @@ module Synco
 		def run_servers(group)
 			target_servers do |server|
 				sync_scope = TargetScope.new(self, server)
-
-				logger.info "===== Processing ====="
-				logger.info "[Master]: #{master_server}"
-				logger.info "[Target]: #{server}"
+				
+				Console.info(self, "Running script...", master: @master_server, target: server)
 				
 				server.try(sync_scope) do
 					@script.directories.each do |directory|
 						directory_scope = DirectoryScope.new(sync_scope, directory)
-
-						logger.info "[Directory]: #{directory}"
+						
+						Console.info(self, "Processing directory...", directory: directory)
+						
 						directory.try(directory_scope) do
 							method.call(directory_scope)
 						end
@@ -146,9 +124,8 @@ module Synco
 	end
 	
 	class LogPipe < DelegateClass(IO)
-		def initialize(logger, level = :info)
+		def initialize(logger: Console, level: :info)
 			@input, @output = IO.pipe
-			@logger = logger
 			
 			super(@output)
 			
@@ -177,10 +154,6 @@ module Synco
 			@from = from
 		end
 		
-		def logger
-			@logger ||= @script_scope.logger
-		end
-		
 		def group
 			@group ||= @script_scope.group
 		end
@@ -195,13 +168,14 @@ module Synco
 				command = self.connection_command + ["--"] + command
 			end
 			
-			logger.info("shell") {[command, options]}
+			Console::Event::Spawn.for(*command, **options).emit(self)
 			
-			options[:out] ||= LogPipe.new(logger)
-			options[:err] ||= LogPipe.new(logger, :error)
+			options[:out] ||= LogPipe.new
+			options[:err] ||= LogPipe.new(level: :error)
 			
 			status = self.group.spawn(*command, **options)
-			logger.debug{"Process finished: #{status}."}
+			
+			Console.info(self, "Command completed.", status: status)
 			
 			options[:out].close
 			options[:err].close
@@ -219,8 +193,8 @@ module Synco
 			@target_server = ServerScope.new(target, script_scope, script_scope.current_server)
 		end
 		
-		def run(*arguments)
-			@target_server.run(*arguments)
+		def run(...)
+			@target_server.run(...)
 		end
 		
 		attr :target_server

data/lib/synco/script.rb

@@ -1,36 +1,21 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
-
-require_relative 'method'
-require_relative 'server'
-require_relative 'directory'
-require_relative 'controller'
-
-require 'socket'
-
-require 'process/group'
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2008-2024, by Samuel Williams.
+
+require_relative "method"
+require_relative "server"
+require_relative "directory"
+require_relative "controller"
+
+require "socket"
+
+require "process/group"
 
 module Synco
 	# The main backup/synchronisation mechanism is the backup script. It specifies all servers and directories, and these are then combined specifically to produce the desired data replication behaviour.
 	class Script < Controller
-		def initialize(method: nil, servers: {}, directories: [], master: :master, logger: nil)
+		def initialize(method: nil, servers: {}, directories: [], master: :master)
 			super()
 			
 			@method = method
@@ -87,7 +72,7 @@ module Synco
 			else
 				# Find a server config that specifies the local host
 				@servers.values.find{|server| localhost?(server.host)}
-			end || Server.new('localhost')
+			end || Server.new("localhost")
 		end
 		
 		def current_server

data/lib/synco/server.rb

@@ -1,32 +1,17 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# frozen_string_literal: true
 
-require_relative 'controller'
-require_relative 'directory'
-require_relative 'shells/ssh'
+# Released under the MIT License.
+# Copyright, 2009-2024, by Samuel Williams.
 
-require 'shellwords'
+require_relative "controller"
+require_relative "directory"
+require_relative "shells/ssh"
+
+require "shellwords"
 
 module Synco
 	class Server < Controller
-		def initialize(name, root: '/', shell: nil, **options)
+		def initialize(name, root: "/", shell: nil, **options)
 			super()
 			
 			@name = name

data/lib/synco/shell.rb

@@ -1,24 +1,9 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# frozen_string_literal: true
 
-require 'pathname'
+# Released under the MIT License.
+# Copyright, 2009-2024, by Samuel Williams.
+
+require "pathname"
 
 module Synco
 	# A shell provides access to a server, typically to run commands.

data/lib/synco/shells/ssh.rb

@@ -1,48 +1,33 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# frozen_string_literal: true
 
-require_relative '../shell'
+# Released under the MIT License.
+# Copyright, 2011-2024, by Samuel Williams.
+
+require_relative "../shell"
 
 module Synco
 	module Shells
 		# SSH shell provides access to a remote server using SSH.
 		class SSH < Shell
 			def default_command
-				['ssh']
+				["ssh"]
 			end
 			
 			def initialize(*command, arguments: [], port: nil, key: nil, user: nil, batch_mode: nil, **options)
 				if port
-					arguments << '-p' << port
+					arguments << "-p" << port
 				end
 				
 				if key
-					arguments << '-i' << key
+					arguments << "-i" << key
 				end
 				
 				if user
-					arguments << '-l' << user
+					arguments << "-l" << user
 				end
 				
 				unless batch_mode.nil?
-					arguments << '-o' << "BatchMode=#{batch_mode ? 'yes' : 'no'}"
+					arguments << "-o" << "BatchMode=#{batch_mode ? 'yes' : 'no'}"
 				end
 				
 				super

data/lib/synco/version.rb

@@ -1,23 +1,8 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2008-2024, by Samuel Williams.
 
 module Synco
-	VERSION = "1.2.0"
+	VERSION = "1.3.1"
 end

data/lib/synco.rb

@@ -1,36 +1,20 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
+# frozen_string_literal: true
 
-require 'yaml'
-require 'socket'
-require 'set'
-require 'logger'
+# Released under the MIT License.
+# Copyright, 2008-2024, by Samuel Williams.
 
-require_relative 'synco/version'
-require_relative 'synco/script'
-require_relative 'synco/scope'
+require "yaml"
+require "socket"
+require "set"
 
-require 'fileutils'
-require 'optparse'
+require_relative "synco/version"
+require_relative "synco/script"
+require_relative "synco/scope"
 
-require 'lockfile'
+require "fileutils"
+require "optparse"
+
+require "lockfile"
 
 module Synco
 	# Run a prepared backup script using a lockfile.

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2008-2024, by Samuel Williams.  
+
+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,39 @@
+# Synco
+
+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.
+  - Backup staging and coordination.
+  - Backup verification using [Fingerprint](https://github.com/ioquatix/fingerprint).
+  - Data backup redundancy controlled via DNS.
+
+[![Development Status](https://github.com/ioquatix/synco/workflows/Test/badge.svg)](https://github.com/ioquatix/synco/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://ioquatix.github.io/synco/) for more details.
+
+  - [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.
+
+  - [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.
+
+  - [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
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.