backblaze-backup/Readme.md

65 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

2023-07-10 12:34:45 +02:00
# Backblaze Backup Tool
This is a tool to backup files and directories to Backblaze.
## Prerequisites
- Go 1.16 or higher
- Backblaze account with a bucket created
- Environment variables `BB_ID` and `BB_KEY` set with your Backblaze account ID and application key respectively
## Building the Application
You can build the application using the provided Makefile.
### On Linux:
```bash
make rebuild
```
### On Windows:
You will need to have make installed. If you don't have it, you can install it through Chocolatey:
```bash
choco install make
```
Then you can run the same command as on Linux:
```bash
make rebuild
```
This will create a binary in the bin directory.
## Running the Application
You can run the application directly from the command line. Here's how to do it:
```bash
./bin/backblaze-backup --bucket "your-bucket-name" --dir "/path/to/directory"
```
Or if you want to upload a single file:
```bash
./bin/backblaze-backup --bucket "your-bucket-name" --file "/path/to/file"
```
2023-07-10 12:43:51 +02:00
You can also use the **`local_run`** command in the Makefile to run the application with a test directory and bucket:
```bash
make local_run DIR="/home/user/test-upload" BUCKET="my-test-bucket"
```
This will run the application with the directory **/home/user/test-upload** and the bucket **my-test-bucket**.
2023-07-10 12:34:45 +02:00
## Flags
--bucket: The name of your Backblaze bucket
--dir: The absolute path of the directory you want to upload to Backblaze
--file: The absolute path of the file you want to upload to Backblaze
Note: You must select just one option, dir or file.
Please replace `"your-bucket-name"`, `"/path/to/directory"`, and `"/path/to/file"` with your actual bucket name and paths.