Site Maintenance project Wiki

This program is free software licensed under The MIT License. A copy of the license is included in license.txt file in the root directory of the project.

This Wiki's intent is to provide documentation covering all aspects of using the included code. There are also a number of blog posts covering this project at www.rustprooflabs.com.

Project Overview

This wiki is currently out of date! The Site Maintenance project has seen major updates in the recent months and we are working on updating the documentation. In the meantime... please do not rely on what you read here being reliable with the newest version.

For the most recent "Production" version use the branch master. You should be ok using the dev branch, but it changes more quickly and is more likely to have minor bugs in it.

The main function of this library is to provide automated, reliable, testable, accessible backups for multiple web sites in one location. The recommended setup uses a Debian server with Jenkins CI to provide scheduling and viewing of jobs. If Jenkins isn't a route you want to go, you should be able to schedule everything via CRON but I have not tested a configuration like that for many versions now.

Features

Regular, reliable backups
Restoring backups (to test they are good backups)
Template Sites
Transfer Archives

The main goal of the project is to provide secure, regular and reliable backups with minimal administrative overhead and maintenance.

Components

This library has 3 main components with two extra functional pieces to support the main goals:

Backup Collection
Restore Site From Backup System
Web Interface

Extra Functionality

Encryption / Decryption
Markdown To HTML
Mantis BT integration (very basic)

Administrators - Start Here

Currently this project requires a certain level of familiarity and experience with managing and configuring servers. The best documentation on how I set up my servers can be found on my blog in a 3-post series that starts here. Keep in mind that security is ultimately up to you, the server setup I describe is only as secure as you make it and choices I make for my development environments are not suitable for production systems.

The Administrator's User Manual will walk you through setting up and configuring the project.

Once your server is up and running - Add sites to the backup schedule

Set up Unit Testing

Non-Administrator Users - Start Here

Warning: Web Interface has been completely removed from this project! View the User's Manual for details on how to take advantage of the packaged web interface to monitor backups, or restore backups to a target sub-domain.