Skip to content

Commit a51dcef

Browse files
author
szjanikowski
committed
Minor quick start tweaks
1 parent 405d1e4 commit a51dcef

1 file changed

Lines changed: 23 additions & 17 deletions

File tree

docs/quick-start.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,29 @@ Before you begin, make sure you have:
2323

2424
## Step 1: Prepare Directory Structure
2525

26-
We recommend creating the following directory structure:
26+
We recommend using the following directory structure:
2727

2828
```
2929
your-workspace/
3030
├── noesis-workspace/
31-
│ ├── data/ # Noesis data (cache, results)
32-
│ └── license.jwt # License file
31+
│ ├── data/ # Noesis data (cache, results) - empty folder
32+
│ └── license.jwt # License file obtained from Noesis team
3333
├── my-system-repo/ # Your .NET repository to analyze
3434
└── noesis-config/ # Noesis DSL configuration project
3535
```
3636

37-
```bash
38-
mkdir -p noesis-workspace/data
39-
# Copy your license file to noesis-workspace/license.jwt
40-
# Clone your .NET repository next to noesis-workspace
41-
# We'll create the configuration project in the next step
37+
At the beginning you will need :
38+
39+
```
40+
your-workspace/
41+
├── noesis-workspace/
42+
│ ├── data/ # Noesis data (cache, results) - empty folder
43+
│ └── license.jwt # License file obtained from Noesis team
4244
```
4345

4446
## Step 2: Docker Authentication
4547

46-
Before running Noesis, you need to authenticate with the Noesis Docker registry:
48+
Start Docker or make sure that it's up. Before running Noesis, you need to authenticate with the Noesis Docker registry:
4749

4850
```bash
4951
docker login ghcr.io -u noesis-packages
@@ -52,20 +54,24 @@ docker login ghcr.io -u noesis-packages
5254

5355
## Step 3: First Noesis Run
5456

55-
Start by running the Noesis container without configuration to check if you can access the UI:
57+
Start by running the Noesis container without configuration to check if you can access the UI.
5658

57-
```bash
59+
Make sure you are in the noesis-workspace directory:
60+
``` bash
5861
cd noesis-workspace
62+
```
5963

64+
Run the basic docker command:
65+
``` bash
6066
docker run \
6167
-v ./data:/data \
6268
-v ./license.jwt:/license.jwt:ro \
63-
-p 3000:8080 \
69+
-p 8088:8080 \
6470
--rm \
6571
ghcr.io/noesisvision/vision:latest
6672
```
6773

68-
Open your browser and navigate to `http://localhost:3000`. You should see the Noesis interface with example repositories.
74+
Open your browser and navigate to `http://localhost:8088`. You should see the Noesis interface with example repositories.
6975

7076
🎉 **First Success!** Noesis is running and you can browse example projects.
7177

@@ -112,14 +118,14 @@ docker run \
112118
-v ../my-system-repo:/externalSources:ro \
113119
-v ./data:/data \
114120
-v ./license.jwt:/license.jwt:ro \
115-
-p 3000:8080 \
121+
-p 8088:8080 \
116122
--rm \
117123
ghcr.io/noesisvision/vision:latest
118124
```
119125

120126
### 4.4: Verify Modules
121127

122-
1. Open `http://localhost:3000`
128+
1. Open `http://localhost:8088`
123129
2. Run a scan of your repository
124130
3. Go to the scan results and click **Modules** section - you should see modules created from your project's namespaces in the tree on the left.
125131

@@ -171,7 +177,7 @@ docker run \
171177
-v ../my-system-repo:/externalSources:ro \
172178
-v ./data:/data \
173179
-v ./license.jwt:/license.jwt:ro \
174-
-p 3000:8080 \
180+
-p 8088:8080 \
175181
--rm \
176182
ghcr.io/noesisvision/vision:latest
177183
```
@@ -233,7 +239,7 @@ docker run \
233239
-v ../my-system-repo:/externalSources:ro \
234240
-v ./data:/data \
235241
-v ./license.jwt:/license.jwt:ro \
236-
-p 3000:8080 \
242+
-p 8088:8080 \
237243
--rm \
238244
ghcr.io/noesisvision/vision:latest
239245
```

0 commit comments

Comments
 (0)