kcal-app / kcal-docker

Docker Compose template for the kcal app.

kcal for Docker!

This is a template repository for running kcal with Docker Compose. Visit the main kcal repository for more information about the application.

Getting Started

1. Clone

Clone this repo.

git clone https://github.com/kcal-app/kcal-docker.git

2. Create .env file.

cd kcal-docker
cp .env.example .env

3. Generate and add an APP_KEY to the .env file.

docker-compose run app php artisan key:generate --show

This command will output a suitable key. Copy the key value and add it to the APP_KEY value in the .env file. This also a good time to review make other changes to the .env file (e.g. set the APP_TIMEZONE and APP_URL values as desired).

4. Launch! 🚀

docker-compose up -d

5. Set up application.

docker-compose exec app php artisan optimize
docker-compose exec app php artisan migrate
docker-compose exec app php artisan elastic:migrate

6. Create initial user.

docker-compose exec app php artisan user:add --admin

7. Log in!

Navigate to http://127.0.0.1/ (or the APP_URL) and log in with the user created in the previous step.

Configuration

Kcal can be configured in various ways using environment variables from the .env file. When changes are made to the environment variables restart the containers and re-run the "optimize" command:

docker-compose restart
docker-compose exec app php artisan optimize

See the kcal configuration documentation for more information about what can be configured and how.