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.

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

Add installation instructions for Linux #1890

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 2 commits
Commits
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
2 changes: 1 addition & 1 deletion docs/sources/k6-studio/_index.md
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ hero:
image: /media/docs/k6/GrafanaLogo_k6Studio_orange.svg
width: 100
height: 100
description: Grafana k6 Studio is an open-source desktop application for macOS and Windows designed to help you generate k6 test scripts.
description: Grafana k6 Studio is an open-source desktop application for macOS, Windows, and Linux designed to help you generate k6 test scripts.
cards:
title_class: pt-0 lh-1
items:
1 change: 1 addition & 0 deletions docs/sources/k6-studio/components/test-validator.md
Original file line number Diff line number Diff line change
@@ -61,6 +61,7 @@ If you want to view the script under the **Scripts** section of the k6 Studio ap
1. Open the k6-studio Scripts folder.
- For macOS, that can be found in `~/Documents/k6-studio/Scripts`.
- For Windows, that can be found in `C:\Users\<USERNAME>\Documents\k6-studio`.
- For Linux, that can be found in ``.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Llandy3d do you know what's the path for Linux here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as macOS: ~/Documents/k6-studio/Scripts

I think on Windows there we are missing the last Scripts part as well 🤔

- If you have a script in k6 Studio already, you can right-click on it and click **Open containing folder**.
2. Copy your script to the Scripts folder.

2 changes: 1 addition & 1 deletion docs/sources/k6-studio/record-your-first-script.md
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ In this tutorial, you will:

To complete this tutorial, you'll need to:

- Have a Windows or macOS machine.
- Have a Windows, macOS, or Linux machine.
- [Install k6 Studio](https://grafana.com/docs/k6-studio/set-up/install/).
- [Install Google Chrome](https://www.google.com/chrome/).

39 changes: 28 additions & 11 deletions docs/sources/k6-studio/set-up/install.md
Original file line number Diff line number Diff line change
@@ -6,24 +6,41 @@ weight: 100

# Install k6 Studio

You can install k6 Studio on Windows and macOS.
You can install k6 Studio on Windows, macOS, and Linux.

## Before you begin

- Install [Google Chrome](https://www.google.com/chrome/) on your computer.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Llandy3d with Linux support, do we need to add something specific about Chromium here, or to the Linux section?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a note that on Linux arm64 only Chromium is supported (because Chrome doesn't exists) 🤔


## Install k6 Studio
## Install k6 Studio on Mac

To install k6 Studio:
To install k6 Studio on macOS:

- Go to the [Releases page](https://github.com/grafana/k6-studio/releases) in the k6 Studio GitHub repository.
- Download the executable file for your system.
- **For Windows**: Click on **k6.Studio-{VERSION}-Setup.exe**.
- **For macOS**: Click on **k6.Studio-{VERSION}-arm64.dmg**.
- After the download finishes, open the executable file.
1. Go to the [Releases page](https://github.com/grafana/k6-studio/releases) in the k6 Studio GitHub repository.
1. Download the executable file for macOS:
- If your Mac has an Apple silicon processor, download **k6.Studio-{VERSION}-arm64.dmg**.
- If your Mac has an Intel silicon processor, download **k6.Studio-{VERSION}-x64.dmg**.
1. After the download finishes, open the executable file.
1. When prompted, move the k6 Studio application file to the Applications folder. This ensure updates can be installed correctly.

{{< admonition type="note" >}}
## Install k6 Studio on Windows

For macOS users, make sure that you install k6 Studio in your Applications folder. If you install it in your Downloads folder, the application won't work correctly.
To install k6 Studio on Windows:

{{< /admonition >}}
1. Go to the [Releases page](https://github.com/grafana/k6-studio/releases) in the k6 Studio GitHub repository.
1. Download the executable file for Windows: **k6.Studio-{VERSION}-Setup.exe**.
1. After the download finishes, open the executable file.

## Install k6 Studio on Linux

To install k6 Studio on Linux:

1. Go to the [Releases page](https://github.com/grafana/k6-studio/releases) in the k6 Studio GitHub repository.
1. Download the executable file for Linux:
- If you're using a Debian-based system, download **k6.Studio-{VERSION}-amd64.deb**.
- If you're using a Red Hat-based system, download **k6.Studio-{VERSION}-x86_64.rpm**.
1. After the download finishes, open your terminal and run:

```bash
sudo dpkg -i <K6_STUDIO_EXECUTABLE>
```
1 change: 1 addition & 0 deletions docs/sources/k6-studio/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -28,5 +28,6 @@ The application logs are saved in the following directory:

- On macOS: ~/Library/Logs/k6 Studio/k6-studio.log
- On Windows: %USERPROFILE%\AppData\Roaming\k6 Studio\logs\k6-studio.log
- On Linux:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Llandy3d do you know the path for Linux here as well?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cristianoventura do you know this one ? 🤔


If have any issues with k6 Studio, include a tail of your log file when [opening an issue on GitHub](https://github.com/grafana/k6-studio).