You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by zk...@apache.org on 2022/11/07 14:34:46 UTC
[incubator-devlake-website] 02/02: Updated note before starting to perform instructions
This is an automated email from the ASF dual-hosted git repository.
zky pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
commit 6af927299c2d38dc935ed0e9d3368d4161007645
Author: PalanikannanM <73...@users.noreply.github.com>
AuthorDate: Sat Nov 5 17:53:56 2022 +0530
Updated note before starting to perform instructions
---
versioned_docs/version-v0.14/GettingStarted/DockerComposeSetup.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/versioned_docs/version-v0.14/GettingStarted/DockerComposeSetup.md b/versioned_docs/version-v0.14/GettingStarted/DockerComposeSetup.md
index f00ff4a3e..71e822bbc 100644
--- a/versioned_docs/version-v0.14/GettingStarted/DockerComposeSetup.md
+++ b/versioned_docs/version-v0.14/GettingStarted/DockerComposeSetup.md
@@ -15,12 +15,12 @@ sidebar_position: 1
- Commands written `like this` are to be run in your terminal.
+NOTE:Before 3, make sure your `.env` file has read/write permissions set for the current user in your machine, else the [API-Server](https://devlake.apache.org/docs/Overview/Architecture) will not start properly
+
1. Download `docker-compose.yml` and `env.example` from [latest release page](https://github.com/apache/incubator-devlake/releases/latest) into a folder.
2. Rename `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).
3. Run `docker-compose up -d` to launch DevLake.
-NOTE:Make sure your `.env` file has read and write permissions set for the current user, else the API Server will not start properly
-
## Collect data and view dashboards
1. Visit `config-ui` at `http://localhost:4000` in your browser to configure DevLake and collect data.