PyRestServer Documentation

PyRestServer is a REST API server for restic backup software with pluggable storage backends.

This package provides a Python implementation of the restic REST API with support for multiple storage backends, including local filesystem and Drime Cloud storage.

Features

• REST API compatible with restic - Drop-in replacement for rest-server

• Upload verification - SHA-256 hash verification for data integrity

• Pluggable storage backends - Local filesystem and cloud storage (Drime)

• Authentication - htpasswd-based authentication support

• Append-only mode - Prevent deletion of existing backups

• TLS support - Secure communication with TLS/SSL

• Prometheus metrics - Built-in metrics endpoint

• Secure configuration - Custom cipher keys for password obscuring

Quick Start

Install pyrestserver:

pip install pyrestserver

Start a server with local storage:

pyrestserver serve --path /tmp/restic --no-auth

Use with restic:

restic -r rest:http://localhost:8000/myrepo init
restic -r rest:http://localhost:8000/myrepo backup /path/to/data

Contents

User Guide

• Installation
  • Basic Installation
  • With Cloud Storage Support
  • Development Installation
  • Requirements
  • System Requirements
  • Installing restic
  • Verifying Installation
  • Upgrading
  • Uninstalling
• Quick Start Guide
  • Starting the Server
  • Using with restic
  • Configuration Management
  • Drime Cloud Backend
  • Common Tasks
  • Next Steps
• Configuration
  • Backend Configuration
  • Server Configuration
  • Authentication Setup
  • TLS/SSL Configuration
  • Append-Only Mode
  • Upload Verification
  • Prometheus Metrics
  • Logging
  • Example Configuration Files
  • Next Steps
• Storage Backends
  • Overview
  • Local Filesystem Backend
  • Drime Cloud Backend
  • Backend Comparison
  • Backend Selection
  • Storage Provider Interface
  • Configuration Management
  • Managing Multiple Backends
  • Next Steps
• Security Best Practices
  • Authentication
  • TLS/SSL Encryption
  • File System Security
  • Configuration Security
  • Network Security
  • Append-Only Mode
  • Repository Security
  • Monitoring and Auditing
  • Backup Security
  • Compliance
  • Security Checklist
  • Common Vulnerabilities
  • Incident Response
  • Next Steps
• Command Line Interface
  • Main Commands
  • serve Command
  • config Command
  • obscure Command
  • Environment Variables
  • Exit Codes
  • Logging Output
  • Integration Examples
  • Troubleshooting
  • Next Steps

Indices and tables

• Index

• Module Index

• Search Page