diff --git a/.gitignore b/.gitignore index 161ca42..5c3740f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,7 @@ # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. # Hosting -/host/convex/docker/data +/docker/data # dependencies node_modules diff --git a/README.md b/README.md index 561f44f..4657ea6 100644 --- a/README.md +++ b/README.md @@ -31,29 +31,27 @@ I would recommend using [bun](https://bun.sh/) to install dependencies. bun i ``` -You will also need docker installed on whatever host you plan to run the Supabase instance from, whether locally, or on a home server or a VPS or whatever. Or you can just use the Supabase SaaS if you want to have a much easier time, probably. I wouldn't know! +You will also need docker installed on whatever host you plan to run the Convex instance from, whether locally, or on a home server or a VPS or whatever. Or you can just use the Convex SaaS if you want to have a much easier time, probably. I wouldn't know! ### Add your environment variables Copy the example environment variable files and paste them in the same directory named `.env`. +Environment variables for Next Application ```bash -cp ./app/next/env.example ./app/next/.env +cp ./apps/next/env.example ./apps/next/.env ``` +Environment variables for Self Hosting Convex & Website with Docker ```bash -cp ./host/convex/docker/env.example ./host/convex/docker/.env +cp ./docker/env.example ./docker/.env ``` -```bash -cp ./host/next/docker/env.example ./host/next/docker/.env -``` - -### Start self hosted convex +### Start self hosted convex & Next Web Application The basic gist is to run the commands below after you have filled out the environment variables you plan to use, but you should ultimately follow the [guide they provide](https://github.com/get-convex/convex-backend/tree/main/self-hosted) ```bash -cd ./host/convex/docker +cd ./docker sudo docker compose up -d sudo docker compose exec convex-backend ./generate_admin_key.sh ``` @@ -66,32 +64,6 @@ Run bun dev ``` -to start your development environment with turbopack - -You can also run - -```bash -bun dev:slow -``` - -to start your development environment with webpack (This is for the next app.) - -### Start your Production Environment. - -There are Dockerfiles & docker compose files that can be found in the `./scripts/docker` folder for the Next.js website. There is also a script called `reload_container` located in the `./scripts/` folder which was created to quickly update the container, but this will give you a better idea of what you need to do. First, build the image with - -```bash -sudo docker compose -f ./host/next/docker/compose.yml build -``` - -then you can run the container with - -```bash -sudo docker compose -f ./host/next/docker/compose up -d -``` - -Now, you may end up with some build errors. The `reload_containers` script swaps out the next config before it runs the docker build to skip any build errors, so you may want to do this as well, though you are welcome to fix the build errors as well, of course! - ### Fin I am sure I am missing a lot of stuff so feel free to open an issue if you have any questions or if you feel that I should add something here! diff --git a/host/next/docker/Dockerfile b/docker/Dockerfile similarity index 93% rename from host/next/docker/Dockerfile rename to docker/Dockerfile index b108c45..75a9838 100644 --- a/host/next/docker/Dockerfile +++ b/docker/Dockerfile @@ -40,11 +40,13 @@ ENV NEXT_TELEMETRY_DISABLED=1 # non-root user RUN addgroup -S nodejs -g 1001 && adduser -S nextjs -u 1001 COPY --from=builder /app/apps/next/public ./public +RUN mkdir .next && chown -R nextjs:nodejs .next RUN mkdir -p .next/cache && chown -R nextjs:nodejs .next # Next standalone output COPY --from=builder /app/apps/next/.next/standalone ./ COPY --from=builder /app/apps/next/.next/static ./.next/static +COPY --from=builder /app/node_modules ./node_modules USER nextjs EXPOSE 3000 diff --git a/host/convex/docker/compose.yml b/docker/compose.yml similarity index 80% rename from host/convex/docker/compose.yml rename to docker/compose.yml index ddc9390..cbb91e1 100644 --- a/host/convex/docker/compose.yml +++ b/docker/compose.yml @@ -1,7 +1,24 @@ networks: - nginx-bridge: # Change this one line to match your network name in env file. + nginx-bridge: # You need to change this line to your defined network is as well external: true + services: + techtracker-next: + build: + context: ../ + dockerfile: ./docker/Dockerfile + image: ${NEXT_CONTAINER_NAME}:alpine + container_name: ${NEXT_CONTAINER_NAME} + env_file: [.env] + hostname: ${NEXT_CONTAINER_NAME} + domainname: ${NEXT_DOMAIN_NAME} + networks: ['${NETWORK:-nginx-bridge}'] + #ports: ['${NEXT_PORT}:3000'] + depends_on: ['convex-backend'] + tty: true + stdin_open: true + restart: unless-stopped + convex-backend: image: ghcr.io/get-convex/convex-backend:${BACKEND_TAG:-00bd92723422f3bff968230c94ccdeb8c1719832} container_name: ${BACKEND_CONTAINER_NAME:-convex-backend} @@ -31,7 +48,6 @@ services: start_period: 10s stop_grace_period: 10s stop_signal: SIGINT - convex-dashboard: image: ghcr.io/get-convex/convex-dashboard:${DASHBOARD_TAG:-33cef775a8a6228cbacee4a09ac2c4073d62ed13} container_name: ${DASHBOARD_CONTAINER_NAME:-convex-dashboard} @@ -52,4 +68,3 @@ services: restart: unless-stopped stop_grace_period: 10s stop_signal: SIGINT - diff --git a/host/convex/docker/env.example b/docker/env.example similarity index 70% rename from host/convex/docker/env.example rename to docker/env.example index 513acd8..32f8731 100644 --- a/host/convex/docker/env.example +++ b/docker/env.example @@ -1,4 +1,14 @@ +# Next Envrionment Variables NETWORK=nginx-bridge +NEXT_CONTAINER_NAME=techtracker-next +NEXT_DOMAIN_NAME=techtracker.gbrown.org +# Port is disabled by default as suggested +# config is to have reverse proxy on the same +# network so you can just forward to the +# port on the internal network. +NEXT_PORT=3000 + +# Convex Environment Variables BACKEND_TAG=00bd92723422f3bff968230c94ccdeb8c1719832 BACKEND_CONTAINER_NAME=tt-convex-backend BACKEND_DOMAIN_NAME=convex.gbrown.org diff --git a/host/next/update b/docker/update similarity index 77% rename from host/next/update rename to docker/update index f18be1e..2c2b51a 100755 --- a/host/next/update +++ b/docker/update @@ -2,7 +2,7 @@ set -e # Exit immediately if a command exits with a non-zero status. # --- Configuration --- -COMPOSE_FILE="./host/next/docker/compose.yml" +COMPOSE_FILE="./docker/compose.yml" DEFAULT_PROJECT_NAME="techtracker" DEV_PROJECT_NAME="dev-techtracker" # The project name for dev mode @@ -38,12 +38,12 @@ while [[ "$#" -gt 0 ]]; do done # --- Main Script Logic --- -echo "--- Pulling latest git changes ---" +echo "\n--- Pulling latest git changes ---\n" git pull -echo "--- Building Docker Compose services ${COMPOSE_PROJECT_FLAG} ---" +echo "\n--- Building Docker Compose services ${COMPOSE_PROJECT_FLAG} ---\n" sudo docker compose -p ${COMPOSE_PROJECT_FLAG} -f "${COMPOSE_FILE}" build -echo "--- Bringing down Docker Compose services ${COMPOSE_PROJECT_FLAG} ---" +echo "\n--- Bringing down Docker Compose services ${COMPOSE_PROJECT_FLAG} ---\n" sudo docker compose -p ${COMPOSE_PROJECT_FLAG} -f "${COMPOSE_FILE}" down -echo "--- Bringing up Docker Compose services ${COMPOSE_PROJECT_FLAG} in detached mode ---" +echo "\n--- Bringing up Docker Compose services ${COMPOSE_PROJECT_FLAG} in detached mode ---\n" sudo docker compose -p ${COMPOSE_PROJECT_FLAG} -f "${COMPOSE_FILE}" up -d -echo "--- Script finished successfully ---" +echo "\n--- Script finished successfully ---\n" diff --git a/host/convex/update b/host/convex/update deleted file mode 100755 index f4b2899..0000000 --- a/host/convex/update +++ /dev/null @@ -1,49 +0,0 @@ -#!/usr/bin/env bash -set -e # Exit immediately if a command exits with a non-zero status. - -# --- Configuration --- -COMPOSE_FILE="./host/convex/docker/compose.yml" -DEFAULT_PROJECT_NAME="techtracker" -DEV_PROJECT_NAME="dev-techtracker" # The project name for dev mode - -COMPOSE_PROJECT_FLAG=${DEFAULT_PROJECT_NAME} # This will hold "-p dev-techtracker" if --dev is used - -# --- Function to display usage --- -usage() { - echo "Usage: $0 [OPTIONS]" - echo "Or: ./update.sh [OPTIONS]" # Assuming the script is named update.sh - echo "" - echo "Options:" - echo " -d, --dev Run in development mode, using project name '${DEV_PROJECT_NAME}'." - echo " Adds '-p ${DEV_PROJECT_NAME}' to docker compose commands." - echo " -h, --help Display this help message." - exit 1 -} - -# --- Parse arguments --- -while [[ "$#" -gt 0 ]]; do - case "$1" in - -d|--dev) - COMPOSE_PROJECT_FLAG=${DEV_PROJECT_NAME} - shift # Consume the argument - ;; - -h|--help) - usage - ;; - *) - echo "Error: Unknown argument '$1'" >&2 - usage - ;; - esac -done - -# --- Main Script Logic --- -echo "--- Pulling latest git changes ---" -git pull -echo "--- Building Docker Compose services ${COMPOSE_PROJECT_FLAG} ---" -sudo docker compose -p ${COMPOSE_PROJECT_FLAG} -f "${COMPOSE_FILE}" build -echo "--- Bringing down Docker Compose services ${COMPOSE_PROJECT_FLAG} ---" -sudo docker compose -p ${COMPOSE_PROJECT_FLAG} -f "${COMPOSE_FILE}" down -echo "--- Bringing up Docker Compose services ${COMPOSE_PROJECT_FLAG} in detached mode ---" -sudo docker compose -p ${COMPOSE_PROJECT_FLAG} -f "${COMPOSE_FILE}" up -d -echo "--- Script finished successfully ---" diff --git a/host/next/docker/compose.yml b/host/next/docker/compose.yml deleted file mode 100644 index 1addf6b..0000000 --- a/host/next/docker/compose.yml +++ /dev/null @@ -1,18 +0,0 @@ -networks: - nginx-bridge: # You need to change this line to your defined network is as well - external: true -services: - techtracker-next: - build: - context: ../../../ - dockerfile: ./host/next/docker/Dockerfile - image: ${CONTAINER_NAME}:alpine - container_name: ${CONTAINER_NAME} - env_file: [.env] - hostname: ${CONTAINER_NAME} - domainname: ${DOMAIN_NAME} - networks: ['${NETWORK:-nginx-bridge}'] - #ports: ['${PORT}:3000'] - tty: true - stdin_open: true - restart: unless-stopped diff --git a/host/next/docker/env.example b/host/next/docker/env.example deleted file mode 100644 index c11b5ee..0000000 --- a/host/next/docker/env.example +++ /dev/null @@ -1,8 +0,0 @@ -NETWORK=nginx-bridge -CONTAINER_NAME=techtracker-next -DOMAIN_NAME=techtracker.gbrown.org -# Port is disabled by default as suggested -# config is to have reverse proxy on the same -# network so you can just forward to the -# port on the internal network. -PORT=3000