# bale

**Repository Path**: gaoshann/bale

## Basic Information

- **Project Name**: bale
- **Description**: https://github.com/natankeddem/bale
ZFS,web admin
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-07
- **Last Updated**: 2025-02-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# bale: ZFS Snapshot Browser Based GUI

## Host Creation
[bale_host_creation.webm](https://github.com/natankeddem/bale/assets/44515217/450afac1-ffa6-4f6f-80b4-1aeafce6a6d7)

## Manual Management Task Handling
[bale_manual_task.webm](https://github.com/natankeddem/bale/assets/44515217/d9728db9-6efa-45ed-8d07-2d925a9249b9)

## Automatic Management Task Handling
[bale_auto_task.webm](https://github.com/natankeddem/bale/assets/44515217/ab648c45-e567-4557-88f9-c11b2b412cef)

## Downloading Files From Snapshots
[bale_file_download.webm](https://github.com/natankeddem/bale/assets/44515217/7db08302-8a8b-47d4-879c-ba310f8628e4)

## Simple Automations
[bale_simple_automation.webm](https://github.com/natankeddem/bale/assets/44515217/0cd6a7da-ff11-4786-88ef-6a644ed431ff)

## ZFS-Autobackup Automations
[bale_zab_automation.webm](https://github.com/natankeddem/bale/assets/44515217/7816ae9c-695c-47f1-9d68-f0075bb8e567)


## ⚠️ **_WARNING_**

**This utility is currently in early development and may undergo breaking changes in future updates. Your configuration may be lost, and snapshot functionality might be affected. Use with caution; data loss may occur.**

## Features

- **Remote Management**: bale handles all interactions over SSH, eliminating the need for local installation. You can manage your ZFS snapshots from anywhere.
- **Multi-Host Support**: Configure bale to manage multiple hosts within the same installation, making it a versatile choice for system administrators.
- **User-Friendly GUI**: Easily manage your ZFS snapshots with an intuitive web-based interface that simplifies the process.
- **Automation**: bale can automate generic remote and local applications as well as work seamlessly with zfs_autobackup, streamlining your backup and snapshot tasks.
- **Download**: Easily download files directly from your ZFS snapshots through the web interface.

## Installation

### Using Docker

1. Download `docker-compose.yml`.

2. Customize the `docker-compose.yml` file to suit your requirements.

3. Run the application using Docker Compose:

   ```bash
   docker-compose up -d
   ```

### Using Proxmox LXC Container

1. Download `pve-install.yml` and `inv.yml`.

2. Ensure you have a compatible Debian template available and updated `inv.yml` accordingly.

3. Customize the `inv.yml` file to match your specific setup requirements.

4. Execute the Ansible playbook for Proxmox LXC container installation against your Proxmox host:

   ```bash
   ansible-playbook -i inv.yml pve-install.yml
   ```

### Manual install on Debian

1. Install required packages.

   ```bash
   sudo apt update
   sudo apt install -y git python3-pip python3-venv sshpass
   ```

2. Clone the repository.

   ```bash
   git clone https://github.com/natankeddem/bale.git
   ```

3. Move to bale directory.

   ```bash
   cd bale
   ```

4. Create python virtual environment.

   ```bash
   python3 -m venv ./venv
   ```

5. Activate virtual environment.

   ```bash
   source ./venv/bin/activate
   ```

6. Install pip3 packages from requirements.txt
   
   ```bash
   pip3 install -r requirements.txt
   ```

7. Exit the virtual environment.
   
   ```bash
   deactivate
   ```

8. Edit `resources/bale.service` with the actual path you are utilizing on your system.

   ```bash
   nano resources/bale.service
   ```

9. Change paths in `resources/bale.service` if needed then copy to service directory and activate.

   ```bash
   sudo cp resources/bale.service /etc/systemd/system
   sudo systemctl enable bale.service
   ```
10. Start the service and check status.

    ```bash
    sudo systemctl start bale.service
    sudo systemctl status bale.service
    ```

    #### Troubleshooting
    If you get an error like this: `bale.service: Failed to locate executable /root/bale/venv/bin/python: No such file or directory`, modify the path in your `/etc/systemd/system/bale.service` file.
    ```bash
    sudo nano /etc/systemd/system/bale.service
    ```

    ```bash
    sudo systemctl daemon-reload
    sudo systemctl start bale.service
    sudo systemctl status bale.service
    ```

### Access GUI

Access bale by navigating to `http://host:8080`.

---