Commands written like this
are to be run in your terminal.
docker-compose.yml
and env.example
from the latest release into a folder.env.example
to .env
. For Mac/Linux users, please run mv env.example .env
in the terminal. This file contains the environment variables that the Devlake server will use. Additional ones can be found in the compose file(s).docker-compose up -d
if the version of Docker Desktop is too low to use docker compose up -d
.config-ui
at http://localhost:4000
in your browser to configure DevLake and collect data.devlake
container takes a while to fully boot up. If config-ui
complains about API being unreachable, please wait a few seconds and refresh the page.localhost:3002
(username: admin
, password: admin
).Support for database schema migration was introduced to DevLake in v0.10.0. From v0.10.0 onwards, users can upgrade their instance smoothly to a newer version. However, versions prior to v0.10.0 do not support upgrading to a newer version with a different database schema.
Yes, please follow the steps below:
docker-compose.yml
:mysql: image: mysql:8 volumes: - mysql-storage:/var/lib/mysql restart: always ports: - "127.0.0.1:3306:3306" environment: MYSQL_ROOT_PASSWORD: admin MYSQL_DATABASE: lake MYSQL_USER: merico MYSQL_PASSWORD: merico command: --character-set-server=utf8mb4 --collation-server=utf8mb4_bin
docker-compose.yml
:volumes: mysql-storage:
docker-compose.yml
:depends_on: - mysql
docker-compose.yml
:MYSQL_URL: 123.45.67.89:3306 MYSQL_DATABASE: mydatabase MYSQL_USER: myuser MYSQL_PASSWORD: mypassword
.env
:DB_URL="mysql://YOUR_USER:YOUR_PASSWORD@YOUR_IP:YOUR_PORT/lake?charset=utf8mb4&parseTime=True" # Don't forget to create db named `lake` in your own db, and set character-set-server=utf8mb4, collation-server=utf8mb4_bin as below # character-set-server=utf8mb4 # collation-server=utf8mb4_bin
docker compose up -d
Yes, please follow the steps below:
grafana: image: mericodev/devlake-dashboard:latest build: context: grafana/ ports: - "3002:3000" volumes: - grafana-storage:/var/lib/grafana environment: GF_SERVER_ROOT_URL: "http://localhost:4000/grafana" GF_USERS_DEFAULT_THEME: "light" MYSQL_URL: mysql:3306 MYSQL_DATABASE: lake MYSQL_USER: merico MYSQL_PASSWORD: merico restart: always depends_on: - mysql
volumes: grafana-storage:
Set config-ui.environment.GRAFANA_ENDPOINT to your own grafana url in docker-compose.yml
Please connect your Grafana to DevLake's database by following https://grafana.com/docs/grafana/latest/administration/data-source-management/
If you want to import dashboards, please check https://grafana.com/docs/grafana/latest/dashboards/export-import/.
docker compose up -d
If you run into any problem, please check the Troubleshooting or create an issue