add script changes and docker-compose configuration for local development

Add build args for Next.js build

.env

@@ -1,32 +0,0 @@
-POSTGRES_USER=unicorn_user
-POSTGRES_PASSWORD=magical_password
-POSTGRES_DB=calendso
-DATABASE_HOST=db:5432
-DATABASE_URL="postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DATABASE_HOST}/${POSTGRES_DB}"
-GOOGLE_API_CREDENTIALS='secret'
-BASE_URL='http://localhost:3000'
-NEXTAUTH_URL='http://localhost:3000'
-
-# Remove this var if you don't want Calendso to collect anonymous usage
-NEXT_PUBLIC_TELEMETRY_KEY=js.2pvs2bbpqq1zxna97wcml.oi2jzirnbj1ev4tc57c5r
-
-# Used for the Office 365 / Outlook.com Calendar integration
-MS_GRAPH_CLIENT_ID=
-MS_GRAPH_CLIENT_SECRET=
-
-# Used for the Zoom integration
-ZOOM_CLIENT_ID=
-ZOOM_CLIENT_SECRET=
-
-# E-mail settings
-# Configures the global From: header whilst sending emails.
-EMAIL_FROM='notifications@example.com'
-
-# Configure SMTP settings (@see https://nodemailer.com/smtp/).
-EMAIL_SERVER_HOST='smtp.example.com'
-EMAIL_SERVER_PORT=587
-EMAIL_SERVER_USER='email_user'
-EMAIL_SERVER_PASSWORD='email_password'
-
-# Encryption key that will be used to encrypt CalDAV credentials, choose a random string, for example with `dd if=/dev/urandom bs=1K count=1 | md5sum`
-CALENDSO_ENCRYPTION_KEY=''

.env.example

@@ -0,0 +1,48 @@
+# Set this value to 'agree' to accept our license:
+# LICENSE: https://github.com/calendso/calendso/blob/main/LICENSE
+#
+# Summary of terms:
+# - The codebase has to stay open source, whether it was modified or not
+# - You can not repackage or sell the codebase
+# - Acquire a commercial license to remove these terms by emailing: license@cal.com
+NEXT_PUBLIC_LICENSE_CONSENT=
+LICENSE=
+
+BASE_URL=http://localhost:3000
+NEXT_PUBLIC_APP_URL=http://localhost:3000
+
+POSTGRES_USER=unicorn_user
+POSTGRES_PASSWORD=magical_password
+POSTGRES_DB=calendso
+DATABASE_HOST=database:5432
+DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DATABASE_HOST}/${POSTGRES_DB}
+GOOGLE_API_CREDENTIALS={}
+
+# Remove this var if you don't want Calendso to collect anonymous usage
+NEXT_PUBLIC_TELEMETRY_KEY=js.2pvs2bbpqq1zxna97wcml.oi2jzirnbj1ev4tc57c5r
+
+# Used for the Office 365 / Outlook.com Calendar integration
+MS_GRAPH_CLIENT_ID=
+MS_GRAPH_CLIENT_SECRET=
+
+# Used for the Zoom integration
+ZOOM_CLIENT_ID=
+ZOOM_CLIENT_SECRET=
+
+# E-mail settings
+# Configures the global From: header whilst sending emails.
+EMAIL_FROM=notifications@example.com
+
+# Configure SMTP settings (@see https://nodemailer.com/smtp/).
+EMAIL_SERVER_HOST=smtp.example.com
+EMAIL_SERVER_PORT=587
+EMAIL_SERVER_USER=email_user
+EMAIL_SERVER_PASSWORD=email_password
+
+# Encryption key that will be used to encrypt CalDAV credentials, choose a random string, for example with `dd if=/dev/urandom bs=1K count=1 | md5sum`
+CALENDSO_ENCRYPTION_KEY=
+
+# It is highly recommended that the JWT secret must be overridden and very unique
+JWT_SECRET=secret
+
+NODE_ENV=production

.github/workflows/docker-build-push-dockerhub.yml

@@ -0,0 +1,70 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Build and push image to DockerHub
+
+# Controls when the workflow will run
+on:
+  push:
+    branches: [main]
+  # update on run of Update Calendso nightly submodule update
+  workflow_run:
+    workflows: ["Update Calendso"]
+    branches: [main]
+    types:
+      - completed
+  # Allow running workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Leaving in example for releases. Initially we simply push to 'latest'
+# on:
+  # release:
+    # types: [ created ]
+
+  # # Allows you to run this workflow manually from the Actions tab
+  # workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - name: Docker Login
+      # You may pin to the exact commit or the version.
+      # uses: docker/login-action@f054a8b539a109f9f41c372932f1ae047eff08c9
+        uses: docker/login-action@v1.10.0
+        with:
+          # Username used to log against the Docker registry
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          # Password or personal access token used to log against the Docker registry
+          password: ${{ secrets.DOCKER_HUB_TOKEN }}
+          # Log out from the Docker registry at the end of a job
+          logout: true # optional, default is true
+
+      - name: Set up Docker builder
+        id: buildx
+        uses: docker/setup-buildx-action@v1.6.0
+        
+      - name: Build and push image
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          context: ./
+          file: ./Dockerfile
+          push: true
+          # The test image is /docker and is private. final image will be /calendso and public
+          tags: docker.io/${{ secrets.DOCKER_HUB_USERNAME }}/calendso:latest
+          build-args: |
+            BASE_URL=http://localhost:3000
+            NEXT_PUBLIC_APP_URL=http://localhost:3000
+
+      - name: Image digest
+        run: echo ${{ steps.docker_build.outputs.digest }}

.gitignore

@@ -0,0 +1,4 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# .env file
+.env

Dockerfile

@@ -1,28 +1,40 @@
-FROM node:14-alpine as deps
+FROM node:14 as deps
 
-RUN apk add --no-cache libc6-compat
 WORKDIR /app
 COPY calendso/package.json calendso/yarn.lock ./
 COPY calendso/prisma prisma
 RUN yarn install --frozen-lockfile
 
-FROM node:14-alpine as builder
+FROM node:14 as builder
+
 WORKDIR /app
+ARG BASE_URL
+ARG NEXT_PUBLIC_APP_URL
+ARG NEXT_PUBLIC_LICENSE_CONSENT
+ARG NEXT_PUBLIC_TELEMETRY_KEY 
+ENV BASE_URL=$BASE_URL \
+    NEXT_PUBLIC_APP_URL=$NEXT_PUBLIC_APP_URL \
+    NEXT_PUBLIC_LICENSE_CONSENT=$NEXT_PUBLIC_LICENSE_CONSENT \
+    NEXT_PUBLIC_TELEMETRY_KEY=$NEXT_PUBLIC_TELEMETRY_KEY
+    
 COPY calendso .
+
 COPY --from=deps /app/node_modules ./node_modules
 RUN yarn build && yarn install --production --ignore-scripts --prefer-offline
 
-FROM node:14-alpine as runner
+FROM node:14 as runner
 WORKDIR /app
 ENV NODE_ENV production
 
+COPY --from=builder /app/node_modules ./node_modules
+COPY --from=builder /app/prisma ./prisma
+COPY --from=builder /app/scripts ./scripts
 COPY --from=builder /app/next.config.js ./
 COPY --from=builder /app/next-i18next.config.js ./
 COPY --from=builder /app/public ./public
 COPY --from=builder /app/.next ./.next
-COPY --from=builder /app/node_modules ./node_modules
 COPY --from=builder /app/package.json ./package.json
-COPY --from=builder /app/prisma ./prisma
 COPY  scripts scripts
+
 EXPOSE 3000
 CMD ["/app/scripts/start.sh"]

README.md

@@ -8,10 +8,22 @@
   <a href="https://github.com/calendso/calendso-docker/issues">Community Support</a>
 </div>
 
-# calendso-docker
+# Docker
+
+This image can be found on DockerHub at [https://hub.docker.com/repository/docker/calendso/calendso](https://hub.docker.com/repository/docker/calendso/calendso)
+
 The Docker configuration for Calendso is an effort powered by people within the community. Calendso does not provide official support for Docker, but we will accept fixes and documentation. Use at your own risk.
 
+## Important Notes
+
+This Docker Image is managed by the Calendso Community. Support for this image can be found via the repository, located at [https://github.com/calendso/docker](https://github.com/calendso/docker)
+
+Currently, this image is intended for local development/evaluation use only, as there are specific requirements for providing environmental variables at build-time in order to specify a non-localhost BASE_URL. (this is due to the nature of the static site compilation, which embeds the variable values). The ability to update these variables at runtime is in-progress and will be available in the future.
+
+For Production, for the time being, please checkout the repository and build/push your own image privately.
+
 ## Requirements
+
 Make sure you have `docker` & `docker-compose` installed on the server / system.
 
 ## Getting Started
@@ -21,25 +33,55 @@ Make sure you have `docker` & `docker-compose` installed on the server / system.
     ```bash
     git clone --recursive https://github.com/calendso/docker.git calendso-docker
     ```
+
 2. Change into the directory
 
     ```bash
     cd calendso-docker
     ```
-3. Update `.env` if needed 
+
+3. Rename `.env.example` to `.env` and update `.env` if needed.
 
 4. Build and start calendso
 
-    ```
+    ```bash
     docker-compose up --build
     ```
 
 5. Start prisma studio
-    ```
+
+    ```bash
     docker-compose exec calendso npx prisma studio
     ```
+
 6. Open a browser to [http://localhost:5555](http://localhost:5555) to look at or modify the database content.
 
 7. Click on the `User` model to add a new user record.
-8.  Fill out the fields (remembering to encrypt your password with [BCrypt](https://bcrypt-generator.com/)) and click `Save 1 Record` to create your first user.
+
+8. Fill out the fields (remembering to encrypt your password with [BCrypt](https://bcrypt-generator.com/)) and click `Save 1 Record` to create your first user.
+
 9. Open a browser to [http://localhost:3000](http://localhost:3000) and login with your just created, first user.
+
+## Git Submodules
+
+This repository uses a git submodule.
+
+If you cloned the repository without using `--recursive`, then you can initialize and clone the submodule with the following steps.
+
+1. Init the submodule
+
+    ```bash
+    git submodule init
+    ```
+
+2. Update the submodule
+
+    ```bash
+    git submodule update --remote
+    ```
+
+For more advanced usage, please refer to the git documentation: [https://git-scm.com/book/en/v2/Git-Tools-Submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
+
+## Troubleshooting
+
+* SSL edge termination: If running behind a load balancer which handles SSL certificates, you will need to add the environmental variable `NODE_TLS_REJECT_UNAUTHORIZED=0` to prevent requests from being rejected. Only do this if you know what you are doing and trust the services/load-balancers directing traffic to your service.

docker-compose.yaml

@@ -1,22 +1,63 @@
 # Use postgres/example user/password credentials
 version: '3.1'
+
+volumes:
+  database-data:
+
+networks:
+  stack:
+    external: false
+
 services:
-  db:
+  database:
     image: postgres
     restart: always
     volumes:
       - database-data:/var/lib/postgresql/data/
     env_file: .env
-    ports:
+    networks:
-      - 5432:5432
+      - stack
+
   calendso:
-    build: .
+    build:
+      context: .
+      dockerfile: Dockerfile
+      args:
+        - BASE_URL=${BASE_URL}
+        - NEXT_PUBLIC_APP_URL=${NEXT_PUBLIC_APP_URL}
+        - NEXT_PUBLIC_LICENSE_CONSENT=${NEXT_PUBLIC_LICENSE_CONSENT}
+        - NEXT_PUBLIC_TELEMETRY_KEY=${NEXT_PUBLIC_TELEMETRY_KEY}
+    image: calendso/calendso:latest
     restart: always
+    networks:
+      - stack
     ports:
       - 3000:3000
+    env_file: .env
+    environment:
+      - DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DATABASE_HOST}/${POSTGRES_DB}
+      - NODE_ENV=development
+    depends_on:
+      - database
+    volumes:
+      - "./calendso:/app/"
+      - "./scripts:/app/scripts"
+
+# Optional use of Prisma Studio. In production, comment out or remove the section below to prevent unwanted access to your database.
+  studio:
+    image: calendso/calendso:latest
+    restart: always
+    networks:
+      - stack
+    ports:
       - 5555:5555
     env_file: .env
+    environment:
+      - DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DATABASE_HOST}/${POSTGRES_DB}
     depends_on:
-      - db
+      - database
-volumes:
+    command:
-  database-data:
+      - npx
+      - prisma
+      - studio
+# END SECTION: Optional use of Prisma Studio.

scripts/start.sh

@@ -1,6 +1,14 @@
-#!/bin/sh
+#!/bin/bash
 set -x
 
-/app/scripts/wait-for-it.sh ${DATABASE_HOST} -- echo "db is up"
+# # Set environment variables
+# echo NEXT_PUBLIC_APP_URL $NEXT_PUBLIC_APP_URL
+# find \( -type d -name .git -prune \) -o -type f -print0 | xargs -0 sed -i "s#$NEXT_PUBLIC_APP_URL#$NEXT_PUBLIC_APP_URL_SUBSTITUTE#g"
+
+/app/scripts/wait-for-it.sh ${DATABASE_HOST} -- echo "database is up"
 npx prisma migrate deploy
-yarn start
+if [[ $NODE_ENV == "development" ]]; then
+    yarn dev
+else
+    yarn start
+fi