Go to file
2021-12-20 04:21:22 +00:00
.github/workflows trigger on branch main only 2021-12-17 12:33:49 -05:00
calendso@3bc659af44 Auto updated submodule references 2021-12-20 04:21:22 +00:00
scripts Make use of internal docker networks unifi database name 2021-12-15 16:01:30 +01:00
.env.example Make use of internal docker networks unifi database name 2021-12-15 16:01:30 +01:00
.gitignore rename .env to .env.example to match calendso repo pattern 2021-10-27 13:08:30 -04:00
.gitmodules Updated .gitmodules to use https & update Calendso submodule every 4 hours 2021-08-16 20:01:23 +00:00
docker-compose.yaml update image paths 2021-12-17 12:14:46 -05:00
Dockerfile add build args and temporarily remove alpine 2021-11-19 10:57:57 -05:00
LICENSE Updated license to MIT to copy main repo 2021-07-02 22:09:43 +01:00
README.md Merge pull request #58 from calendso/feature/actions 2021-12-17 17:35:26 +00:00

Docker

This image can be found on DockerHub at 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

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

  1. Clone calendso-docker

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

    cd calendso-docker
    
  3. Rename .env.example to .env and update .env if needed.

  4. Build and start calendso

    docker-compose up --build
    
  5. Start prisma studio

    docker-compose exec calendso npx prisma studio
    
  6. Open a browser to 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) and click Save 1 Record to create your first user.

  9. Open a browser to 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

    git submodule init
    
  2. Update the submodule

    git submodule update --remote
    

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.