Giter Club home page Giter Club logo

calcom-docker's Introduction

Docker

NOTE: DockerHub organization has not yet been renamed.

This image can be found on DockerHub at https://hub.docker.com/r/calendso/calendso

The Docker configuration for Cal.com is an effort powered by people within the community. Cal.com, Inc. does not yet provide official support for Docker, but we will accept fixes and documentation at this time. Use at your own risk.

Important Notes

This Docker Image is managed by the Cal.com Community. Support for this image can be found via the repository, located at https://github.com/calcom/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.

Note: docker compose without the hyphen is now the primary method of using docker-compose, per the Docker documentation.

Getting Started

  1. Clone calcom-docker

    git clone https://github.com/calcom/docker.git calcom-docker
  2. Change into the directory

    cd calcom-docker
  3. Update the calcom submodule.

    git submodule update --remote --init

    Note: DO NOT use recursive submodule update, otherwise you will receive a git authentication error.

  4. Rename .env.example to .env and then update .env

  5. Build and start Cal.com via docker compose

    docker compose up --build
  6. (First Run) Open a browser to http://localhost:5555 to look at or modify the database content.

    a. Click on the User model to add a new user record.

    b. Fill out the fields (remembering to encrypt your password with BCrypt) and click Save 1 Record to create your first user.

  7. Open a browser to http://localhost:3000 and login with your just created, first user.

Configuration

Build-time variables

These variables must be provided at the time of the docker build, and can be provided by updating the .env file. Changing these is not required for evaluation, but may be required for running in production. Currently, if you require changes to these variables, you must follow the instructions to build and publish your own image.

  • NEXT_PUBLIC_WEBAPP_URL
  • NEXT_PUBLIC_LICENSE_CONSENT
  • NEXT_PUBLIC_TELEMETRY_KEY

Important Run-time variables

  • NEXTAUTH_SECRET

Git Submodules

This repository uses a git submodule.

To update the calcom submodule, use the following command:

git submodule update --remote --init

For more advanced usage, please refer to the git documentation: 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.
  • Failed to commit changes: Invalid 'prisma.user.create()': Certain versions may have trouble creating a user if the field metadata is empty. Using an empty json object {} as the field value should resolve this issue. Also, the id field will autoincrement, so you may also try leaving the value of id as empty.

calcom-docker's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.