docs: Add quick start guide #602

m-rudyk · 2024-09-12T06:54:04Z

Pull Request

Description

Create separate 'docker compose' for quick start with minimal setup. Update corresponding instruction easy setup and first try.

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Code cleanup/refactoring
Documentation update
This change requires a documentation update
CI system update
Test Coverage update

Testing

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

Test Configuration:

Java: v17
LPVS Release: v1.x.x

Checklist:

My code follows the style guidelines of this project
My code meets the required code coverage for lines (90% and above)
My code meets the required code coverage for branches (80% and above)
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

o-kopysov

Please check my comments.

o-kopysov · 2024-09-12T06:56:47Z

doc/docs/user-guide/service/quick-start-guide.md

+### [Quick Start Guide](#quick-start-guide-1)
+
+1. [Setting up your project to interact with _LPVS_](#1-setting-up-your-project-to-interact-with-lpvs)
+2. [Using pre-built _LPVS_ Docker images](#2-using-pre-built-lpvs-docker-images)
+3. [Setting up your project to interact with _LPVS_](#3-setting-up-your-project-to-interact-with-lpvs)
+
+---
+


Please follow the style of other documentation files.

o-kopysov · 2024-09-12T06:57:11Z

doc/docs/user-guide/service/quick-start-guide.md

+> [!NOTE]
+> Pay attention that the token must be copied immediately after creation, because you will not be able to see it later!!


Use note style like in other pages of the guide.

o-kopysov · 2024-09-12T06:57:45Z

doc/docs/user-guide/service/quick-start-guide.md

+1.1 Create a personal github access token (`personal-token`):
+
+- Follow the instructions [here](#https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) to create a personal access token with the necessary permissions.


This part is already presented in the guide. Just give a link to the correct page.

o-kopysov · 2024-09-12T06:58:59Z

doc/docs/user-guide/service/quick-start-guide.md

+1.2 Get a personal ngrok auth token to expose your local service (`auth-token`):
+
+- The ngrok agent authenticates with an authtoken. Your authtoken is available on the ngrok [dashboard](https://dashboard.ngrok.com/get-started/your-authtoken).


This information should be placed on the page where the webhook configuration is described. Please update those page and remove this description from here.

in case of ngrok installation, we use different approach: installing token to system, and run command without auth token. If this service included in docker, we require auth token to set.

o-kopysov · 2024-09-12T06:59:21Z

doc/docs/user-guide/service/quick-start-guide.md

+
+2.1.1 Open `docker-compose.yml` file.


You changed the name of the file.

o-kopysov · 2024-09-12T06:59:54Z

doc/docs/user-guide/service/quick-start-guide.md

+### 3. Setting up your project to interact with _LPVS_
+
+3.1 Configure the [webhook](/doc/docs/user-guide/service/webhook.md#configure-the-webhook-in-your-github-repository-settings) in your GitHub repository settings:
+
+- Go to `Settings` -> `Webhooks`.
+- Click on `Add webhook`.
+- Fill in the `Payload URL` with: `<Tunnel URL>:7896/webhooks`.
+  > The `Tunnel URL` can be found on localhost: `http://127.0.0.1:4040/`.
+- Specify the content type as `application/json`.
+- Fill in the `Secret` field with the passphrase: `LPVS`.
+- Select `Let me select individual events` -> `Pull requests` (make sure only `Pull requests` is selected).
+- Set the webhook to `Active`.
+- Click `Add Webhook`.


This description is presented in the documentation. Just place a link.

o-kopysov · 2024-09-12T07:00:26Z

docker-compose-quick.yml

+      ## Required if frontend and backend are different
+      #- frontend.main-page.url=http://localhost:3000
+      #- cors.allowed-origin=http://localhost:3000
+      ## Database Configuration
+      - spring.datasource.url=jdbc:mysql://mysqldb:3306/lpvs
+      - spring.datasource.username=root
+      - spring.datasource.password=
+      - spring.jpa.properties.hibernate.default_schema=lpvs
+      ## Github data for fetching code
+      - github.login=
+      - github.token=
+      - github.api.url=https://api.github.com
+      - github.secret=LPVS
+      ## Google OAuth Login
+      - spring.security.oauth2.client.registration.google.client-id=GOOGLE_CLIENT_ID
+      - spring.security.oauth2.client.registration.google.client-secret=GOOGLE_CLIENT_SECRET
+      - spring.security.oauth2.client.registration.google.redirect-uri=http://localhost:7896/login/oauth2/code/google
+      - spring.security.oauth2.client.registration.google.scope=profile, email
+      ## Github OAuth Login
+      - spring.security.oauth2.client.registration.github.client-id=GITHUB_CLIENT_ID
+      - spring.security.oauth2.client.registration.github.client-secret=GITHUB_CLIENT_SECRET
+      - spring.security.oauth2.client.registration.github.redirect-uri=http://localhost:7896/login/oauth2/code/github
+      - spring.security.oauth2.client.registration.github.scope=user
+      ## Github Enterprise Configuration if necessary
+      #- spring.security.oauth2.client.provider.github.authorization-uri=https://HOSTNAME/login/oauth/authorize
+      #- spring.security.oauth2.client.provider.github.token-uri=https://HOSTNAME/login/oauth/access_token
+      #- spring.security.oauth2.client.provider.github.user-info-uri=https://HOSTNAME/api/v3/user
+


Remove all unnecessary lines that are not used in quick start guide.

codecov-commenter · 2024-09-12T07:01:36Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.89%. Comparing base (91fcb85) to head (58b2e31).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##               main     #602   +/-   ##
=========================================
  Coverage     93.89%   93.89%           
  Complexity      611      611           
=========================================
  Files            51       51           
  Lines          2112     2112           
  Branches        244      244           
=========================================
  Hits           1983     1983           
  Misses           57       57           
  Partials         72       72

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

o-kopysov · 2024-09-12T10:44:27Z

doc/docs/user-guide/service/quick-start-guide.md

+# Quick Start Guide
+
+---


According to the template, after the name of the section, we have to write a short sentence (brief) of the page. It will be placed at the center.

o-kopysov · 2024-09-12T10:47:23Z

doc/mkdocs.yml

@@ -34,6 +34,7 @@ nav:
      - Service mode:
          - GitHub webhook configuration: user-guide/service/webhook.md
          - Run service using pre-built Docker image: user-guide/service/docker.md
+          - Quick Start Guide: user-guide/service/quick-start-guide.md


Incorrect place. Check line 31 and replace Getting Started with Quick Start Guide.

o-kopysov · 2024-09-12T10:48:06Z

docker-compose-quick.yml

+      ## Google OAuth Login
+      - spring.security.oauth2.client.registration.google.client-id=GOOGLE_CLIENT_ID
+      - spring.security.oauth2.client.registration.google.client-secret=GOOGLE_CLIENT_SECRET
+      - spring.security.oauth2.client.registration.google.redirect-uri=http://localhost:7896/login/oauth2/code/google
+      - spring.security.oauth2.client.registration.google.scope=profile, email
+      ## Github OAuth Login
+      - spring.security.oauth2.client.registration.github.client-id=GITHUB_CLIENT_ID
+      - spring.security.oauth2.client.registration.github.client-secret=GITHUB_CLIENT_SECRET
+      - spring.security.oauth2.client.registration.github.redirect-uri=http://localhost:7896/login/oauth2/code/github
+      - spring.security.oauth2.client.registration.github.scope=user


Do we really need this for the default profile? These options are used in Web profile.

I've tested solution without this part and we got error like below:
Exception in thread "main" java.lang.ClassNotFoundException: org.springframework.boot.loader.thin.ThinJarLauncher at java.base/java.net.URLClassLoader.findClass(URLClassLoader.java:445) at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:587) at java.base/java.lang.ClassLoader.loadClass(ClassLoader.java:520) at org.springframework.boot.loader.wrapper.ThinJarWrapper.launch(ThinJarWrapper.java:138) at org.springframework.boot.loader.wrapper.ThinJarWrapper.main(ThinJarWrapper.java:107)

I am not sure how to remove this part properly, so I tend to keep it

o-kopysov · 2024-09-12T10:48:47Z

doc/docs/user-guide/service/webhook.md

@@ -18,6 +18,16 @@ to create a personal access token (`personal-token`) with the necessary permissi

 ---

+## (Optional) Configure Ngrok reverse proxy:


o-kopysov · 2024-09-12T10:51:27Z

doc/docs/user-guide/service/quick-start-guide.md

+
+---
+
+## 1. Setting up your project to interact with _LPVS_ service


I prefer to remove numbers.

o-kopysov · 2024-09-12T10:51:44Z

doc/docs/user-guide/service/quick-start-guide.md

+
+To enable _LPVS_ license scanning for your project, you need to set up GitHub Webhooks.
+
+* Create a personal github access token (`personal-token`):


o-kopysov · 2024-09-12T10:52:05Z

doc/docs/user-guide/service/quick-start-guide.md

+
+  - Follow the instructions [here](/doc/docs/user-guide/service/webhook.md#create-a-personal-github-access-token) to create a personal access token with the necessary permissions.
+
+!!! note


!!! warning

o-kopysov · 2024-09-12T11:05:11Z

doc/docs/user-guide/service/quick-start-guide.md

+
+* Get a personal ngrok auth token to expose your local service (`auth-token`):
+
+  - The ngrok agent authenticates with an authtoken. Your authtoken is available on the ngrok [dashboard](https://dashboard.ngrok.com/get-started/your-authtoken).


Better to use [Ngrok portal]

o-kopysov · 2024-09-12T11:06:05Z

doc/docs/user-guide/service/quick-start-guide.md

+
+## 3. Setting up your project to interact with _LPVS_
+
+Configure the [webhook](/doc/docs/user-guide/service/webhook.md#configure-the-webhook-in-your-github-repository-settings) in your GitHub repository settings:


o-kopysov · 2024-09-12T11:06:33Z

doc/docs/user-guide/service/quick-start-guide.md

+Configure the [webhook](/doc/docs/user-guide/service/webhook.md#configure-the-webhook-in-your-github-repository-settings) in your GitHub repository settings:
+
+Configuration from your project side is now complete!
+You can now create a new pull request or update an existing one with commits. _LPVS_ will automatically start scanning and provide comments about the licenses found in the project.


Add screenshot with the results.

how about this one?

Please use white color theme

Hide your account name

Use new format of LPVS output

updated image

o-kopysov · 2024-09-12T11:07:38Z

doc/docs/user-guide/service/webhook.md

+
+To configure GitHub access to a personal server, you need to expose the URL to an external API. If the server has a dedicated IP address or domain, this step can be omitted.
+
+- Install ngrok and connect your account from [here](https://ngrok.com/docs/getting-started/#step-2-install-the-ngrok-agent) (follow steps 1 and 2).


here -> Ngrok guide

o-kopysov · 2024-09-12T11:08:37Z

doc/docs/user-guide/service/webhook.md

+
+- If ngrok included in docker compose, auth token can be found on [Ngrok portal](https://dashboard.ngrok.com/get-started/your-authtoken).
+
+- Run ngrok using the command: `ngrok http 7896`.


Use

ngrok http 7896

in here need clarification

Use the same style of command line commands as previously.

```bash command ```

o-kopysov

Please check my comments

o-kopysov

LGTM

o-konoval

LGTM

Signed-off-by: Mykola Rudyk <m.rudyk@samsung.com>

Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>

m-rudyk self-assigned this Sep 12, 2024

m-rudyk requested review from tiokim, MoonkiHong, o-kopysov and tdrozdovsky as code owners September 12, 2024 06:54

m-rudyk force-pushed the m.rudyk/update_quick_guide branch from 71e4ae3 to 53d3d84 Compare September 12, 2024 06:55

o-kopysov requested changes Sep 12, 2024

View reviewed changes

m-rudyk requested a review from o-kopysov September 12, 2024 09:59

m-rudyk force-pushed the m.rudyk/update_quick_guide branch 2 times, most recently from e2ed1fd to 852ebaa Compare September 12, 2024 10:17

o-kopysov reviewed Sep 12, 2024

View reviewed changes

m-rudyk force-pushed the m.rudyk/update_quick_guide branch from 852ebaa to 2286214 Compare September 12, 2024 11:32

m-rudyk requested a review from o-kopysov September 12, 2024 12:07

m-rudyk force-pushed the m.rudyk/update_quick_guide branch from 2286214 to 8c1e73f Compare September 12, 2024 12:55

o-kopysov requested review from o-konoval and t-naumenko September 12, 2024 14:09

o-kopysov added the documentation Improvements or additions to documentation label Sep 12, 2024

o-kopysov added this to the v2.0.0 milestone Sep 12, 2024

o-kopysov changed the title ~~feat: edit quick start guide~~ feat: Add quick start guide Sep 12, 2024

o-kopysov changed the title ~~feat: Add quick start guide~~ docs: Add quick start guide Sep 12, 2024

o-kopysov approved these changes Sep 12, 2024

View reviewed changes

o-konoval approved these changes Sep 12, 2024

View reviewed changes

m-rudyk and others added 3 commits September 12, 2024 20:12

feat: edit quick start guide

f290f7f

Signed-off-by: Mykola Rudyk <m.rudyk@samsung.com>

fix: apply changes after review comments

13523b0

Signed-off-by: Mykola Rudyk <m.rudyk@samsung.com>

fix: Fix quick start guide and update readme file

58b2e31

Signed-off-by: Oleg Kopysov <o.kopysov@samsung.com>

o-kopysov force-pushed the m.rudyk/update_quick_guide branch from b6631fa to 58b2e31 Compare September 12, 2024 17:12

o-kopysov merged commit b90cc88 into main Sep 12, 2024
10 checks passed

o-kopysov deleted the m.rudyk/update_quick_guide branch September 12, 2024 17:16

		> [!NOTE]
		> Pay attention that the token must be copied immediately after creation, because you will not be able to see it later!!

		1.1 Create a personal github access token (`personal-token`):

		- Follow the instructions [here](#https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) to create a personal access token with the necessary permissions.

		1.2 Get a personal ngrok auth token to expose your local service (`auth-token`):

		- The ngrok agent authenticates with an authtoken. Your authtoken is available on the ngrok [dashboard](https://dashboard.ngrok.com/get-started/your-authtoken).

		@@ -18,6 +18,16 @@ to create a personal access token (`personal-token`) with the necessary permissi

		---

		## (Optional) Configure Ngrok reverse proxy:


		---

		## 1. Setting up your project to interact with _LPVS_ service


		To enable _LPVS_ license scanning for your project, you need to set up GitHub Webhooks.

		* Create a personal github access token (`personal-token`):


		- Follow the instructions [here](/doc/docs/user-guide/service/webhook.md#create-a-personal-github-access-token) to create a personal access token with the necessary permissions.

		!!! note


		* Get a personal ngrok auth token to expose your local service (`auth-token`):

		- The ngrok agent authenticates with an authtoken. Your authtoken is available on the ngrok [dashboard](https://dashboard.ngrok.com/get-started/your-authtoken).


		## 3. Setting up your project to interact with _LPVS_

		Configure the [webhook](/doc/docs/user-guide/service/webhook.md#configure-the-webhook-in-your-github-repository-settings) in your GitHub repository settings:


		To configure GitHub access to a personal server, you need to expose the URL to an external API. If the server has a dedicated IP address or domain, this step can be omitted.

		- Install ngrok and connect your account from [here](https://ngrok.com/docs/getting-started/#step-2-install-the-ngrok-agent) (follow steps 1 and 2).


		- If ngrok included in docker compose, auth token can be found on [Ngrok portal](https://dashboard.ngrok.com/get-started/your-authtoken).

		- Run ngrok using the command: `ngrok http 7896`.

docs: Add quick start guide #602

docs: Add quick start guide #602

Conversation

m-rudyk commented Sep 12, 2024 • edited Loading

Pull Request

Description

Type of change

Testing

Checklist:

o-kopysov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-rudyk Sep 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented Sep 12, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

o-kopysov Sep 12, 2024 • edited Loading

Choose a reason for hiding this comment

m-rudyk Sep 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

o-kopysov left a comment

Choose a reason for hiding this comment

o-kopysov left a comment

Choose a reason for hiding this comment

o-konoval left a comment

Choose a reason for hiding this comment

m-rudyk commented Sep 12, 2024 •

edited

Loading

m-rudyk Sep 12, 2024 •

edited

Loading

codecov-commenter commented Sep 12, 2024 •

edited

Loading

o-kopysov Sep 12, 2024 •

edited

Loading

m-rudyk Sep 12, 2024 •

edited

Loading