forge_backup 0.6.0

A program to backup all the user home folders to an S3 bucket.
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

# Forge Backup

`forge_backup` is a backup application for Linux servers. I developed this for Laravel Forge servers, however it will work with any linux server. It will backup each users home folder into a temp folder and then upload that to an AWS S3 Bucket, deleting the temp file on completion. It will also use Mailgun API to report any failures (or success by configuration).

## Requirements

- Rust 1.74 or newer
- `libssl-dev` (on Debian-based systems) or `openssl-devel` (on Amazon Linux)
- `zip`
- `aws-cli`
- Configured AWS CLI with access keys (`aws configure`)

### Rust toolchain

To install the rust toolchain, run the following command
```sh
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

## Installation

To install `forge_backup`, ensure you have the Rust toolchain installed, then run:

```sh
cargo install forge_backup
```

## Usage

To use `forge_backup`, run the following command:

```sh
forge_backup [OPTIONS]
```

### Options
- --temp-folder <TEMP_FOLDER>: Specify where to create the temp archives.
- --s3-bucket <S3_BUCKET>: Specify the S3 bucket for backups.
- --s3-folder <S3_FOLDER>: Specify the folder in the S3 bucket.
- --home-dir <HOME_DIR>: Specify the home directory to back up (default: /home).
- --notify-success <NOTIFY_SUCCESS>: Notify on success (possible values: true, false).
- --alert-email <ALERT_EMAIL>: Email to alert in case of failure.
- --exclude-users <EXCLUDE_USERS>: Users to exclude from backup.
- --hostname <HOSTNAME>: Specify the hostname.
- -h, --help: Print help information.
- -V, --version: Print version information.


### Example

```sh
forge_backup --s3-bucket my-backup-bucket --s3-folder daily-backups --notify-success true --alert-email admin@example.com
```

## Configuration

You can create a configuration file at `~/.config/forge-backup/forge_backup.toml`. The command-line parameters will override the config file values. Following is a template for the config file.

```toml
exclude_users = []
exclude_files = [
    "**/ai1m-backups/*",
    "**/node_modules/*",
    "**/.cache/*",
    "**/.npm/*",
    "**/vendor/*",
]
temp_folder = "~/tmp/backups"
home_dir = "/home"
hostname = "{$HOSTNAME}"
s3_bucket = ""
s3_folder = "daily"
alert_email = ""
notify_on_success = false
mailgun_api_base = ""
mailgun_api_key = ""
mailgun_domain = ""
sender_email = ""
```

### Environment Variables

Environment variables can be used in the config file like this:

```toml
hostname = "{$HOSTNAME}"
```

## Contribution Guidelines

We welcome contributions. Please follow these guidelines:

1. Fork the repository and clone your fork.
2. Create new branch for your feature or bugfix.
3. Make your changes and test thoroughly.
4. Commit your changes with clear and descriptive commit messages.
5. Push your branch to your forkl.
6. Open a pull request and describe your changes.

## License

This project is licensed under the MIT License.

## Issues and Feature Requests

If you encounter any issues or have feature requests, please submit them on our GitHub Issues page.

## Contact

For any questions or support, please feel free to reach out via GitHub.

Thank you for using `forge_backup`!