Merge pull request #28 from voltdatalab/caprover-yml

Update Instructions, Add Scripts

Author: rafaelcalpena

README.md

@@ -60,6 +60,18 @@ A dynamic card manager built on top of Ghost CMS.
     . ./reset.sh
     ```
 
+**Note:** If you intend to build production images locally for the commands above, use `up-local.sh` and `setup-local.sh` instead of the other scripts, respectively.
+
+### Installation with CapRover (One-Click App)
+
+We have created a one-click app template which can be used in CapRover instances. You can use it by following these steps ([source](https://github.com/caprover/one-click-apps?tab=readme-ov-file#test-your-one-click-apps)):
+
+- Login to your CapRover dashboard
+- Go to `apps` and click on `One-Click Apps/Databases`
+- Select `>> TEMPLATE <<` at the bottom of the dropdown list
+- Copy and paste the `xarta.yml` file from this repository, then click `Next`.
+- Provide the necessary variables and follow remaining instructions.
+
 ## Xarta Customization
 
 - You may configure styling for classes `xarta-card`, `xarta-title`, `xarta-excerpt`, `xarta-updated-at`, `xarta-content`, `xarta-footer`, `xarta-custom-logo`, `xarta-default-logo` to further customize your card.

docker-compose.local.yml

@@ -0,0 +1,13 @@
+
+# This docker-compose.local.yml file should override the docker-compose.yml file
+
+services:
+  next:
+    # Force local build
+    build: 
+      dockerfile: ./Dockerfile.next
+
+  setup-helper:
+    # Force local build
+    build:
+      context: ./tools/setup

docker-compose.yml

@@ -20,9 +20,6 @@ services:
   next:
     container_name: ${PROJECT_NAME}-next
     image: ghcr.io/voltdatalab/xarta
-    # TODO: Add custom option to force local build
-    # build: 
-      # dockerfile: ./Dockerfile.next
     environment:
       # TODO: Verify all env vars have been added
       # Required for get-settings
@@ -102,9 +99,6 @@ services:
     image: ghcr.io/voltdatalab/xarta-setup
     volumes:
       - setup_helper_data:/.setup-helper
-    # TODO: Add custom option to force local build
-    # build:
-      # context: ./tools/setup
     environment:
       CADDY_CONTAINER_NAME: "${PROJECT_NAME}-caddy"
       PROJECT_NAME: ${PROJECT_NAME}

prod/setup-local.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+set -e
+
+# Force the script to use project's root directory instead of the current working directory
+# See: https://stackoverflow.com/a/24114056
+scriptDir=$(dirname -- "$(readlink -f -- "$BASH_SOURCE")")
+echo "Script dir: ${scriptDir}"
+pushd $scriptDir/..
+
+
+# Configure sudo if required, verify docker is running
+. ./tools/scripts/utils.sh
+
+# Source .env to get variables like $PROJECT_NAME
+source .env
+
+echo "Initializing ${PROJECT_NAME}"
+
+# TODO: Change this to production and dev
+$sudo_cmd docker compose -f docker-compose.yml -f docker-compose.local.yml up setup-helper ghost caddy -d --build
+
+clear
+
+$sudo_cmd docker attach ${PROJECT_NAME}-setup-helper
+
+# Only remove the container, but not networks still in use
+$sudo_cmd docker compose stop setup-helper
+$sudo_cmd docker compose rm -f setup-helper
+
+popd

prod/up-local.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+set -e
+
+# Force the script to use project's root directory instead of the current working directory
+# See: https://stackoverflow.com/a/24114056
+scriptDir=$(dirname -- "$(readlink -f -- "$BASH_SOURCE")")
+echo "Script dir: ${scriptDir}/.."
+pushd $scriptDir/..
+
+. ./tools/scripts/utils.sh
+
+# Source .env to get variables like $PROJECT_NAME
+source .env
+
+echo "Current directory: $(pwd)"
+echo "Initializing ${PROJECT_NAME}"
+
+# Build and start containers
+$sudo_cmd docker compose -f docker-compose.yml -f docker-compose.local.yml up --build -d
+
+popd