'\" t .\" Title: GB-TRANSFER-SERVICE .\" Author: halfdog .\" Generator: DocBook XSL Stylesheets vsnapshot .\" Date: 09/16/2023 .\" Manual: User Manual .\" Source: guerillabackup .\" Language: English .\" .TH "GB\-TRANSFER\-SERVIC" "1" "09/16/2023" "guerillabackup" "User Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .\" http://bugs.debian.org/507673 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" gb-transfer-service \- Synchronise guerillabackup backup data storages .SH "SYNOPSIS" .HP \w'\fBgb\-transfer\-service\fR\ 'u \fBgb\-transfer\-service\fR \fB\-\-Config\ \fR\fB\fIfile\fR\fR .SH "DESCRIPTION" .PP This is the manual page for the \fBgb\-transfer\-service\fR command\&. For more details see packaged documentation at /usr/share/doc/guerillabackup\&. The service has two main purposes: providing a stream\-based protocol for interaction with other gb\-transfer\-service instances and application of storage and retrieval policies for data synchronisation\&. .PP The network part uses a local (AF_UNIX) socket to listen for incoming connections (see /run/guerillabackup/transfer\&.socket below)\&. There is no authentication magic or likely\-to\-be\-flawed custom\-made crypto included in that part: any process allowed to open the socket can talk the protocol\&. For connectivity and authentication, use your favourite (trusted) tools\&. Good starting points are socat with OPENSSL X509 client/server certificate checks on one side and UNIX\-CONNECT:/run/guerillabackup/transfer\&.socket for the other one\&. When using SSH to forward such connections, you should consider key\-based authentication with command forcing (command="/usr/bin/socat \- UNIX\-CONNECT:/run/guerillabackup/transfer\&.socket") and default security options (restrict)\&. .PP The policies are the other domain of the gb\-transfer\-service\&. They define the authorisation rules granting access to backup data elements but do NOT grant access to the remote file system as such or allow creation or restore of backups\&. That is the domain of gb\-backup\-generator tool\&. The policy also defines, which backup elements should be copied or moved to other storages\&. Each gb\-transfer\-service may have two polices: one defining, what should be sent to other instances (sender policy) and what should be received (receiver policy)\&. Without defining a policy for a transfer direction, no data will be sent in that direction\&. Currently there are two predefined policies: .PP ReceiverStoreDataTransferPolicy: this policy attempts to create a copy of each file offered by a remote sender and keeps it, even after the sender stopped providing it\&. This policy is useful to fetch all files from a remote storage\&. .PP SenderMoveDataTransferPolicy: this policy offers all backup files in the local storage for transfer\&. Depending on the settings, files are deleted after sending or just flagged as sent after successful transfer\&. .PP A policy implements one of the policy interfaces, that are ReceiverTransferPolicy and SenderTransferPolicy\&. You may create a custom policy when the predefined do not match your requirements\&. .SH "OPTIONS" .PP \fB\-\-Config \fR\fB\fIfile\fR\fR .RS 4 This optional parameter specifies an alternative configuration file instead of /etc/guerillabackup/config\&. .RE .SH "FILES" .PP /etc/guerillabackup/config .RS 4 The main configuration file for all guerillabackup tools\&. Use /etc/guerillabackup/config\&.template to create it\&. The template also contains the documentation for each available parameter\&. The most relevant parameters for gb\-transfer\-service are TransferServiceStorageBaseDir, TransferReceiverPolicyClass, TransferReceiverPolicyInitArgs, TransferSenderPolicyClass, TransferSenderPolicyInitArgs\&. .RE .PP /run/guerillabackup/transfer\&.socket .RS 4 This is the default socket file name to connect two gb\-transfer\-service instances\&. The path can be changed by modification of "GeneralRuntimeDataDir" configuration property from default "/run/guerillabackup"\&. By default, the socket is only accessible to privileged users and the user, who created it (mode 0600)\&. You might change permissions after startup to grant access to other users also\&. .RE .SH "BUGS" .PP For guerillabackup setups installed from packages, e\&.g\&. \&.deb or \&.rpm files usually installed via package management software, e\&.g\&. apt\-get, aptitude, rpm, yast, please report bugs to the package maintainer\&. .PP For setups from unpackaged software trunk, please report at \m[blue]\fB\%https://github.com/halfdog/guerillabackup/issues\fR\m[]\&. .SH "SEE ALSO" .PP \fBgb-backup-generator\fR(1) .SH "AUTHOR" .PP \fBhalfdog \fR <\&me@halfdog\&.net\&> .RS 4 Wrote this manual page\&. .RE .SH "COPYRIGHT" .br Copyright \(co 2016-2023 halfdog .br .PP This manual page was written for guerillabackup system on Linux systems, e\&.g\&. Debian\&. .PP Permission is granted to copy, distribute and/or modify this document under the terms of the Lesser GNU General Public License, Version 3\&. .PP On Debian systems, the complete text of the Lesser GNU General Public License can be found in /usr/share/common\-licenses/LGPL\-3\&. .sp