Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

adjust to version v0.18.0-beta6 #628

Merged
merged 2 commits into from
Aug 20, 2023
Merged

adjust to version v0.18.0-beta6 #628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0bb1f12
adjust to version v0.18.0-beta6
ZhangNing10 Aug 18, 2023
f2951ef
adjust the tz part to fix the format issue
ZhangNing10 Aug 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/GettingStarted/DockerComposeSetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 1

## Launch DevLake

1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.18.0-beta3) into a folder.
1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.18.0-beta6) 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. Generate a secure encryption key using a method such as OpenSSL. For example, run the following command to generate a 128-character string consisting of uppercase letters:

Expand All @@ -29,7 +29,9 @@ sidebar_position: 1

**Please make sure to keep the ENCRYPTION_SECRET safe as it is used to encrypt sensitive information in the database, such as personal access tokens and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt this sensitive information.**

4. Run `docker-compose up -d` if the version of Docker Desktop is too low to use `docker compose up -d`.
4. By default, the timezone is UTC. You can change it by adjusting the env variable TZ in docker-compose.yml

5. Run `docker-compose up -d` if the version of Docker Desktop is too low to use `docker compose up -d`.

## Collect data and view dashboards

Expand Down
10 changes: 6 additions & 4 deletions docs/GettingStarted/HelmSetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,14 @@ To install the chart with release name `devlake`,follow these steps:
**Please make sure to keep the ENCRYPTION_SECRET safe as it is used to encrypt sensitive information in the database, such as personal access tokens and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt this sensitive information.**


3. Install the chart by running the following commands:
3. By default, the timezone is UTC. You can set your timezone via --set envs.TZ="your timezone"

4. Install the chart by running the following commands:

```shell
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
helm install devlake devlake/devlake --version=0.18.0-beta3 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.18.0-beta6 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```

And visit your devlake from the node port (32001 by default).
Expand Down Expand Up @@ -79,14 +81,14 @@ grafana by url `http://YOUR-NODE-IP:30091`

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.18.0-beta3 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.18.0-beta6 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
```

**If you're upgrading from DevLake v0.18.x or later versions:**

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.18.0-beta3
helm upgrade devlake devlake/devlake --version=0.18.0-beta6
```

### Uninstall
Expand Down
6 changes: 4 additions & 2 deletions versioned_docs/version-v0.18/GettingStarted/DockerComposeSetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 1

## Launch DevLake

1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.18.0-beta5) into a folder.
1. Download `docker-compose.yml` and `env.example` from the [latest release](https://github.com/apache/incubator-devlake/releases/tag/v0.18.0-beta6) 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. Generate a secure encryption key using a method such as OpenSSL. For example, run the following command to generate a 128-character string consisting of uppercase letters:

Expand All @@ -29,7 +29,9 @@ sidebar_position: 1

**Please make sure to keep the ENCRYPTION_SECRET safe as it is used to encrypt sensitive information in the database, such as personal access tokens and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt this sensitive information.**

4. Run `docker-compose up -d` if the version of Docker Desktop is too low to use `docker compose up -d`.
4. By default, the timezone is UTC. You can change it by adjusting the env variable TZ in docker-compose.yml

5. Run `docker-compose up -d` if the version of Docker Desktop is too low to use `docker compose up -d`.

## Collect data and view dashboards

Expand Down
9 changes: 5 additions & 4 deletions versioned_docs/version-v0.18/GettingStarted/HelmSetup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,14 @@ To install the chart with release name `devlake`,follow these steps:

**Please make sure to keep the ENCRYPTION_SECRET safe as it is used to encrypt sensitive information in the database, such as personal access tokens and passwords. If ENCRYPTION_SECRET is lost, it may not be possible to decrypt this sensitive information.**

3. By default, the timezone is UTC. You can set your timezone via --set envs.TZ="your timezone"

3. Install the chart by running the following commands:
4. Install the chart by running the following commands:

```shell
helm repo add devlake https://apache.github.io/incubator-devlake-helm-chart
helm repo update
helm install devlake devlake/devlake --version=0.18.0-beta5 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
helm install devlake devlake/devlake --version=0.18.0-beta6 --set lake.encryptionSecret.secret=$ENCRYPTION_SECRET
```

And visit your devlake from the node port (32001 by default).
Expand Down Expand Up @@ -79,14 +80,14 @@ grafana by url `http://YOUR-NODE-IP:30091`

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.18.0-beta5 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
helm upgrade devlake devlake/devlake --version=0.18.0-beta6 --set lake.encryptionSecret.secret=<ENCRYPTION_SECRET>
```

**If you're upgrading from DevLake v0.18.x or later versions:**

```shell
helm repo update
helm upgrade devlake devlake/devlake --version=0.18.0-beta5
helm upgrade devlake devlake/devlake --version=0.18.0-beta6
```

### Uninstall
Expand Down
Loading