Skip to content

Latest commit

 

History

History
60 lines (37 loc) · 2.11 KB

README.md

File metadata and controls

60 lines (37 loc) · 2.11 KB

Kimai Dockers

We provide a set of docker images for the Kimai v2 project.

The built images are available from Kimai v2 at Docker Hub.

Deving and Contributing

We use commit linting to generate commits that we can auto generate changelogs from. To set these up, you will need node/nvm installed:

nvm use
npm install

See CONTRIBUTING.md for more details.

Quick start

Run the latest production build:

  1. Start a DB

    docker run --rm --name kimai-mysql-testing \
    -e MYSQL_DATABASE=kimai \
    -e MYSQL_USER=kimai \
    -e MYSQL_PASSWORD=kimai \
    -e MYSQL_ROOT_PASSWORD=kimai \
    -p 3399:3306 -d mysql

  2. Start Kimai

    docker run --rm --name kimai-test \
    -ti \
    -p 8001:8001 \
    -e DATABASE_URL=mysql://kimai:kimai@${HOSTNAME}:3306/kimai \
    kimai/kimai2:apache

Note: If you're using Docker for Windows or Docker for Mac, and you're getting "Connection refused" or other errors, you might need to change ${HOSTNAME} to host.docker.internal. This is because the Kimai Docker container can only communicate within its network boundaries. Another option would be to start the container with the flag --network="host". See here for more information.

  1. Add a user, open a new terminal and:

    docker exec -ti kimai-test \
    /opt/kimai/bin/console kimai:create-user admin [email protected] ROLE_SUPER_ADMIN

You can now hit the kimai instance on http://localhost:8001

This docker transient and will disappear when you stop the containers.

docker stop kimai-mysql-testing kimai-test

Using docker-compose

This will run the latest prod version using FPM with an nginx reverse proxy

See the docker-compose.yml in the root of this repo.

Documentation

https://tobybatch.github.io/kimai2/