.. figure:: images/ConfiBack.png
    :alt: ConfiBack Logo
    :align: left
    :height: 32pt
    :width: 32pt

Installing ConfiBack
====================

Requirements
------------

* `Python 2.7 <http://www.python.org/>`_
* `Django 1.5 <https://www.djangoproject.com>`_
* `SQLite 3 <http://www.sqlite.org>`_
* `Paramiko 1.10 <https://github.com/paramiko/paramiko>`_ (if you will use SSH2 connection type)

.. note::
  Linux users usually have this software available in distribution repositories.

.. note::
  Django and Paramiko can be installed using *easy_install* or *pip* install helper.
  

Download
--------

Download project from `SourceForge.net <https://sourceforge.net/projects/confiback/>`_
  
Set up
------

Go to confiback directory and do:
  
* ``./manage.py syncdb``

  * You just installed Django's auth system, which means you don't have any superusers defined. Would you like to create one now? (yes/no): ``yes``
  * Username: ``your_username``
  * Email address: ``your@email.address``
  * Password: ``password``
  * Password (again): ``password``
    
Web management
--------------

ConfiBack has web management interface. You can start it temporarily thanks to Django development web server, or permanently by placing to some Web server which supports Python (eg. Apache HTTP Server).

* To start Django development web server on the localhost go to *confiback* directory, invoke command ``./manage.py runserver``, launch your web browser and visit the address http://localhost:8000/ - you must open it on server, where ConfiBack is installed.
* To place ConfiBack to web server see the `Django on Apache and WSGI <https://docs.djangoproject.com/en/dev/howto/deployment/wsgi/modwsgi/>`_ manual.
  
CLI management
--------------

.. note::
  Not implemented.

.. _backup_schedule::
  
Backup scheduling
-----------------

There is a possibility to schedule all devices backup using *backup_all_devices.py* Python script.

Create your cron.d script file called *confiback* like this:
  
.. code::
  
  0 23 * * * root cd /srv/www/confiback/; /usr/bin/python ./backup_all_devices.py
  
Make *confiback* file executable ``chmod +x confiback`` and move it into */etc/cron.d* directory. Every day at 11 p.m. will run this backup script. Downloaded configuration backups are saved into database only if they have differences to last backed up version.