email/INSTALL.md

# Unraid Installation Guide - Email Signature Manager

Follow these steps to deploy the Email Signature Manager on your Unraid server using a local build and the Unraid Docker GUI.

## Step 1: Clone the Repository
SSH into your Unraid server (or use the Terminal in the WebUI) and run:

```bash
cd /mnt/user/appdata
git clone https://git.alwisp.com/jason/email.git email-sigs
cd email-sigs
```

## Step 2: Add your Google Service Account Key
Place your `sa.json` file (acquired from Google Cloud Console) into the `secrets` folder.

```bash
# Example if copying via SMB from Windows:
# Copy sa.json to \\UNRAID-IP\appdata\email-sigs\secrets\sa.json
```

## Step 3: Build the Image Locally
In the terminal, run the build command to create your local Docker image:

```bash
cd /mnt/user/appdata/email-sigs
docker build -t email-sigs:latest .
```

## Step 4: Configure the Container in Unraid GUI
Now, go to the **Docker** tab in your Unraid WebUI and click **Add Container** at the bottom. Fill out the fields exactly as follows:

- **Name:** `email-sig-manager`
- **Repository:** `email-sigs:latest`
- **Network Type:** `Bridge`
- **WebUI Port:** `3000`

### Add Path Mappings
Click **+ Add another Path, Port, Variable, Label or Device** for each of these:

1. **Secrets Path**
   - **Name:** `Secrets`
   - **Container Path:** `/app/secrets`
   - **Host Path:** `/mnt/user/appdata/email-sigs/secrets`
   - **Access Mode:** `Read Only`

2. **Data Path**
   - **Name:** `Data`
   - **Container Path:** `/app/data`
   - **Host Path:** `/mnt/user/appdata/email-sigs/data`
   - **Access Mode:** `Read/Write`

### Add Variables
Click **+ Add another Path, Port, Variable, Label or Device** for each of these:

1. **Admin Email**
   - **Key:** `GOOGLE_ADMIN_EMAIL`
   - **Value:** *(your Workspace admin email, e.g., jason@messagepoint.tv)*

2. **Admin Username**
   - **Key:** `ADMIN_USERNAME`
   - **Value:** `admin`

3. **Admin Password**
   - **Key:** `ADMIN_PASSWORD`
   - **Value:** *(your chosen password)*

4. **Cron Schedule** (Optional)
   - **Key:** `CRON_SCHEDULE`
   - **Value:** `0 2 * * *`

## Step 5: Click Apply
Once all fields are filled, click **Apply**. Unraid will start the container using your locally built image. You can then access the UI at `http://UNRAID-IP:3000`.