morlandi / django_restic_gui

A GUI web application for restic backup

Django restic gui

About

This is a project to create a GUI for the restic backup system based on the Django Framework.

Features:

• Inspect Backups (Navigate through backup tree)
• Restore Backups or parts of it (to default or to selectable location)
• Instant Backup

Project status

This project was created for personal use, so it's not perfect by now.

Feel free to fork and change things, if i'm lucky, you will add improvements via pull requests.

Todo

• Error handling (runs quite optimistic by now)
• logging
• Add missing features from restic commands
  • Encryption of backups
  • Remote backups
  • Compare or check backups
  • ...
• Tests

Prerequisites

[Optional] Install virtual environment:

$ python -m virtualenv env

[Optional] Activate virtual environment:

On macOS and Linux:

$ source env/bin/activate

On Windows:

$ .\env\Scripts\activate

Install dependencies:

$ pip install -r requirements.txt

You will need to add a localsettings.py configuration file to the project directory (right beneath the settings.py) to configure all your local environment setings.

The deploy directory contains a template for that.

How to run

Default

You can run the application from the command line with manage.py. Go to the root folder of the application.

Run migrations:

$ python manage.py migrate

Run server on port 8000:

$ python manage.py runserver 8000

Post Installation

Django

Add an admin user to manage the site. Run the following command:

$ python manage.py createsuperuser

Enter your desired username and press enter.

Username: admin_username

You will then be prompted for your desired email address:

Email address: [e-mail]

The final step is to enter your password. You will be asked to enter your password twice, the second time as a confirmation of the first.

Password: **********
Password (again): *********
Superuser created successfully.

Go to the web browser and visit http://localhost:8000/admin to create your first restic repository. The repository must exist, since the app is not able to create one at this time. See restic docs for details.