restic-123pan 0.3.1

Restic REST API backend server using 123pan cloud storage
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

# Restic REST API Server for 123pan

A Restic REST API backend server that uses 123pan cloud storage as the storage provider.

## Features

- Full Restic REST API v2 support
- Automatic directory creation via 123pan's containDir feature
- Token auto-refresh for seamless authentication
- Supports backup, restore, snapshots, and all restic operations

## Requirements

- Rust 1.70+
 - 123pan account credentials (username and password)
- restic CLI (for testing)

## Installation

```bash
cargo build --release
```

## Usage

### Environment Variables

| Variable | Description | Default |
|----------|-------------|---------|
| `PAN123_USERNAME` | 123pan username (phone/email) | (required) |
| `PAN123_PASSWORD` | 123pan account password | (required) |
| `PAN123_REPO_PATH` | Root folder path on 123pan | `/restic-backup` |
| `LISTEN_ADDR` | Server listen address (host/IP) | `127.0.0.1` |
| `LISTEN_PORT` | Server listen port | `8000` |
| `RUST_LOG` | Log level (trace, debug, info, warn, error) | `info` |

### Running the Server

```bash
# Using environment variables
export PAN123_USERNAME=your_username
export PAN123_PASSWORD=your_password
cargo run --release

# Or using command line arguments
cargo run --release -- \
  --username your_username \
  --password your_password \
  --repo-path /my-restic-backup \
  --listen-addr 0.0.0.0 \
  --listen-port 8000
```

### Using with Restic

```bash
# Initialize a new repository
export RESTIC_PASSWORD="your-secure-password"
restic -r rest:http://127.0.0.1:8000/ init

# Backup files
restic -r rest:http://127.0.0.1:8000/ backup /path/to/files

# List snapshots
restic -r rest:http://127.0.0.1:8000/ snapshots

# Restore files
restic -r rest:http://127.0.0.1:8000/ restore latest --target /path/to/restore
```

## API Endpoints

| Method | Path | Description |
|--------|------|-------------|
| POST | `/?create=true` | Initialize repository |
| DELETE | `/` | Delete repository (not implemented) |
| HEAD | `/config` | Check if config exists |
| GET | `/config` | Get config file |
| POST | `/config` | Save config file |
| GET | `/:type/` | List files of type (data, keys, locks, snapshots, index) |
| HEAD | `/:type/:name` | Check if file exists |
| GET | `/:type/:name` | Download file |
| POST | `/:type/:name` | Upload file |
| DELETE | `/:type/:name` | Delete file |

## Testing

```bash
# Set credentials
export PAN123_USERNAME=your_username
export PAN123_PASSWORD=your_password

# Run all tests
cargo test

# Run integration tests only
cargo test --test integration_test

# Run e2e tests (requires restic CLI)
cargo test --test e2e_test
```

## Project Structure

```
src/
├── main.rs           # Entry point, CLI parsing, server setup
├── config.rs         # Configuration handling
├── error.rs          # Error types
├── pan123/
│   ├── mod.rs        # Module exports
│   ├── client.rs     # 123pan HTTP client
│   ├── auth.rs       # Token management with auto-refresh
│   └── types.rs      # 123pan API request/response types
└── restic/
    ├── mod.rs        # Module exports
    ├── handler.rs    # Axum route handlers
    └── types.rs      # Restic REST API types

tests/
├── integration_test.rs  # Integration tests with 123pan API
└── e2e_test.rs          # End-to-end tests with restic CLI
```

## License

MIT