configuration_file

Files Cloud Backuper Configuration File

The configuration file is an XML file with the following information:

<configuration>
    <performance>
            <cipher_threads>3</cipher_threads>
            <sender_threads>1</sender_threads>  
            <max_pending_for_processing>10</max_pending_for_processing>
    </performance>

    <stored_files>
        <max_size_in_bytes>10000000</max_size_in_bytes>
        <should_encrypt>1</should_encrypt>
        <should_check_already_sent>1</should_check_already_sent>
        <delete_temp_files>1</delete_temp_files>
    </stored_files>

    <mail_sender>
       <account>
           <src>
               <mail>myuser@yahoo.com</mail>           
           <user>myuser@yahoo.com</user>
           <pass>mypass</pass>
           <server>smtp.mail.yahoo.com</server>
           </src>
           <subject_prefix>FCB: </subject_prefix>
           <dst_mail>myuser@yahoo.com</dst_mail>
           <dst_mail>myuser@gmail.com</dst_mail>
           <retries>5</retries>
           <time_between_retries>1</time_between_retries>
       </account>
    </mail_sender>
    <sent_files_log>files_sent.log</sent_files_log>
</configuration>

Configuration settings description

• performance
  • cipher_threads : amount of threads to use for encrypting files. A higher number will generate files to send faster but will use more processing power. In general because the real bottleneck is the sending part, it doesn't make sense to set this to a really big number (1, 2 or 3 should be OK).
  • sender_threads : amount of threads for sending files. It only makes sense to set this to a value greater than 1 if the you have enough upstream bandwidth to upload more than one file at the time and if the mail server restricts the bandwidth per connection or you have configured more than one destination server (<account> configuration).
  • max_pending_for_processing : this is the maximum allowed number of pending to send files. Because the file processing operation generates copies of the information to upload, if there wasn't such restriction, your local storage would fill up with that information. You can interpret this setting as being the allowed storage space to be used for processing (that would be around <max_pending_for_processing> times <max_size_in_bytes>). If this number is low (eg. 1) the upload process may take longer (since the program will need to wait for new files to be ready before it can continue uploading the data).
• stored_files
  • max_size_in_bytes : maximum number of bytes of data to be archived for upload (note that this is not the size of the file to be uploaded but, in general, defines a maximum size for it).
  • should_encrypt : if "1" uploaded archives will be encrypted (each one with an different and automatically generated key that will be stored locally).
  • should_check_already_sent : if "1" the program will check that a file wasn't already uploaded before processing it again. In general you won't disable this option (that is, set it to "0") unless you want to upload again some files or if you are sure that the files weren't uploaded before and you want to save some processing power.
  • delete_temp_files : if "1" all (temporal) files generated for processing will be deleted when the associated archive is successfully uploaded. In general you will want this option enabled (it only makes sense for debugging purposes). Note that despite the configured value, these files are stored temporal storage and will be removed after system reboot.
• mail_sender : Mail sender logic (to save archives to a mail server). This tag is optional, if you don't specify this tag, a pseudo sender will be used (prints some debugging information to let the user know that a file would have been sent).
  • account : specification of mail servers where archives should be stored. You can specify many of this tags (meaning different servers to be used).
    • src
      • mail : source e-mail address for the message generated (will be the "From:" address in the generated e-mail)
      • user : username to use for logging in the e-mail server used for sending the e-mail with the uploaded archive.
      • pass : password associated to the user specified for logging in.
      • server : mail server to use for sending the files
    • subject_prefix : if specified, is the prefix that will be used in the subject of the sent mail. The subject will be of the form "<subject_prefix><attachment>" where "<attachment>" is the archive attached to the e-mail (uploaded files).
    • dst_mail : specifies the destination e-mail address where the archives should be sent (that is, where the information will be stored). This tag may be repeated so the information is stored in multiple places.
    • retries : amount of retries that should be done uppon sending failure (eg. in case of server congestion). The total amount of tries will be 1 (the first try) + <retries>.
    • time_between_retries : Time to wait before trying to send a file again (retry).
• sent_files_log : path where information about data sent will be stored (in addition to the internal database of the program). This log serves to register which files have been sent and which key was used for encrypting them (if encryption was configured as active).