chore: update docker-compose for multiarch

Author: johnpc

.github/workflows/docker-publish.yml

@@ -1,4 +1,4 @@
-name: Build and Publish Docker Image
+name: Build and Publish Multi-Architecture Docker Image
 
 on:
   push:
@@ -19,14 +19,16 @@ jobs:
     permissions:
       contents: read
       packages: write
-      # This is used to complete the identity challenge
-      # with sigstore/fulcio when running outside of PRs.
       id-token: write
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
 
+      # Set up QEMU for multi-architecture builds
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
       # Set up Docker Buildx
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
@@ -52,12 +54,13 @@ jobs:
             type=sha,format=long
             type=raw,value=latest,enable={{is_default_branch}}
 
-      # Build and push Docker image
+      # Build and push Docker image for multiple architectures
       - name: Build and push Docker image
         id: build-and-push
         uses: docker/build-push-action@v4
         with:
           context: .
+          platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

README.md

@@ -27,39 +27,88 @@ BookGrab focuses on doing one thing well: making it easy to search MAM and downl
 
 ### Prerequisites
 
-- Node.js 18+ and npm
 - A MyAnonyMouse account and session token
 - A running Transmission client
 
-### Environment Variables
+### Installation Options
 
-Create a `.env.local` file in the root directory with the following variables:
+#### Option 1: Docker Compose (Recommended)
 
+1. Create a `docker-compose.yml` file:
+
+```yaml
+version: '3'
+
+services:
+  bookgrab:
+    image: mrorbitman/bookgrab:latest
+    container_name: bookgrab
+    ports:
+      - "3000:3000"
+    environment:
+      - MAM_TOKEN=your_mam_token_here
+      - TRANSMISSION_URL=http://your-transmission-server:9091/transmission/rpc
+      - AUDIOBOOK_DESTINATION_PATH=/path/to/audiobooks
+      - EBOOK_DESTINATION_PATH=/path/to/ebooks
+    restart: unless-stopped
 ```
-MAM_TOKEN=your_mam_token_here
-TRANSMISSION_URL=http://your-transmission-server:9091/transmission/rpc
-AUDIOBOOK_DESTINATION_PATH=/path/to/audiobooks
-EBOOK_DESTINATION_PATH=/path/to/ebooks
+
+2. Update the environment variables with your own values
+3. Run the container:
+
+```bash
+docker-compose up -d
 ```
 
-### Installation
+4. Access BookGrab at http://localhost:3000
+
+#### Option 2: Docker
 
-1. Clone the repository
-2. Install dependencies:
+Run the container directly:
+
+```bash
+docker run -d \
+  --name bookgrab \
+  -p 3000:3000 \
+  -e MAM_TOKEN=your_mam_token_here \
+  -e TRANSMISSION_URL=http://your-transmission-server:9091/transmission/rpc \
+  -e AUDIOBOOK_DESTINATION_PATH=/path/to/audiobooks \
+  -e EBOOK_DESTINATION_PATH=/path/to/ebooks \
+  mrorbitman/bookgrab:latest
+```
+
+#### Option 3: Manual Installation
+
+1. Prerequisites:
+   - Node.js 18+ and npm
+
+2. Clone the repository
+3. Install dependencies:
 
 ```bash
 npm install
 ```
 
-3. Run the development server:
+4. Create a `.env.local` file in the root directory with the following variables:
+
+```
+MAM_TOKEN=your_mam_token_here
+TRANSMISSION_URL=http://your-transmission-server:9091/transmission/rpc
+AUDIOBOOK_DESTINATION_PATH=/path/to/audiobooks
+EBOOK_DESTINATION_PATH=/path/to/ebooks
+```
+
+5. Run the development server:
 
 ```bash
 npm run dev
 ```
 
-4. Open [http://localhost:3000](http://localhost:3000) with your browser to see the application.
+6. Open [http://localhost:3000](http://localhost:3000) with your browser to see the application.
+
+### Building for Production
 
-## Building for Production
+If you're installing manually, you can build for production:
 
 ```bash
 npm run build

docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+
+services:
+  bookgrab:
+    image: mrorbitman/bookgrab:latest
+    container_name: bookgrab
+    ports:
+      - "3000:3000"
+    env_file:
+      - .env
+    restart: unless-stopped