- Docker v19.03.10+
- docker-compose v2.2.3+ (If you have Docker Desktop installed then you already have the Compose plugin installed)
- Commands written
like thisare to be run in your terminal.
env.examplefrom latest release page into a folder.
.env. For Mac/Linux users, please run
mv env.example .envin 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 -dto launch DevLake.
Configure and collect data
http://localhost:4000in your browser to configure and collect data.
- Please follow the tutorial
devlaketakes a while to fully boot up. if
config-uicomplaining about api being unreachable, please wait a few seconds and try refreshing the page.
- Click View Dashboards button in the top left when done, or visit
Upgrade to a newer version
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. We recommend users to deploy a new instance if needed.