Skip to content

Commit 65fb881

Browse files
author
szjanikowski
committed
Clean-up of setup documentation
1 parent 3e7e495 commit 65fb881

1 file changed

Lines changed: 5 additions & 35 deletions

File tree

docs/setup.md

Lines changed: 5 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
sidebar_position: 1
33
---
44

5-
# P3 Model .NET - Container Configuration
5+
# Noesis Vision - Container Configuration
66

77
## Introduction
88

9-
P3 Model .NET is an advanced source code analysis system with AI integration that supports various language model providers. The system is designed as a containerized application with flexible configuration through environment variables.
9+
Noesis Vision is an advanced source code analysis system with an optional AI integration that supports various language model providers. The system is designed as a containerized application with flexible configuration through environment variables.
1010

1111
## Supported APIs and Models
1212

@@ -84,7 +84,6 @@ Here are the environment variables which have to be set to use each of listed mo
8484
| `NOESIS_NoesisLicenseFilePath` | Yes | Path to JWT license file |
8585

8686

87-
8887
**Notes:**
8988
- License file must be in JWT format
9089
- In container, file must be mounted at `/license.jwt`
@@ -94,8 +93,7 @@ Here are the environment variables which have to be set to use each of listed mo
9493

9594
| Variable | Required | Default Value | Description |
9695
|----------|----------|---------------|-------------|
97-
| `NOESIS_IsMultiTenant` | No | `false` | Enables multi-tenant mode |
98-
| `NOESIS_FeatureManagement__AdvancedMode` | No | `false` | Enables advanced mode with additional features |
96+
| `NOESIS_FeatureManagement__AdvancedMode` | No | `false` | Enables experimental features |
9997
| `NOESIS_FeatureManagement__FileUpload` | No | `false` | Enables file upload functionality |
10098

10199
### Logging Configuration
@@ -104,12 +102,6 @@ Here are the environment variables which have to be set to use each of listed mo
104102
|----------|----------|---------------|-------------|
105103
| `NOESIS_LogLevel` | No | `Information` | Logging level: `Debug`, `Information`, `Warning`, `Error` |
106104

107-
### Parser Configuration (for Parser container)
108-
109-
| Variable | Required | Description |
110-
|----------|----------|-------------|
111-
| `NOESIS_OutputPath` | Yes | Path to output file (JSON) |
112-
| `NOESIS_System` | Yes | Name of system to analyze |
113105

114106
## Usage Examples
115107

@@ -161,44 +153,22 @@ docker run \
161153
ghcr.io/noesisvision/vision:latest
162154
```
163155

164-
### Parser Container
165-
166-
```bash
167-
docker run \
168-
-v /path/to/config:/app/externalConfig:ro \
169-
-v /path/to/sources:/externalSources:ro \
170-
-v /path/to/data:/app/data \
171-
-e NOESIS_OutputPath=/app/data/output.json \
172-
-e NOESIS_System=MySystem \
173-
--rm \
174-
ghcr.io/noesisvision/parser:latest
175-
```
176156

177157
## Container Volumes
178158

179-
### Vision Container
180-
181159
| Volume | Type | Description |
182160
|--------|------|-------------|
183161
| `/externalConfig` | Read-only | External configuration directory (.NET class library with Noesis rules) |
184162
| `/externalSources` | Read-only | System sources directory for analysis (optional, if configuration uses local git repositories) |
185163
| `/data` | Read-write | Volume for Noesis Vision managed data (cache, analysis results) |
186164
| `/license.jwt` | Read-only | JWT license file |
187165

188-
### Parser Container
189-
190-
| Volume | Type | Description |
191-
|--------|------|-------------|
192-
| `/app/externalConfig` | Read-only | External configuration directory |
193-
| `/externalSources` | Read-only | System sources directory |
194-
| `/app/data` | Read-write | Volume for parser data and analysis results |
195166

196167
## Notes and Best Practices
197168

198169
### Security
199-
1. **API Keys**: Never hardcode API keys in Docker images. Use environment variables or secret management.
200-
2. **Permissions**: In container, application runs as user `$APP_UID` (default 1000).
201-
3. **Licenses**: License file must be available in container at `/license.jwt`.
170+
1. **Permissions**: In container, application runs as user `$APP_UID` (default 1000).
171+
1. **Licenses**: License file must be available in container at `/license.jwt`.
202172

203173
### Configuration
204174
1. **AWS Region**: AWS Bedrock is configured for `us-east-1` region (hardcoded).

0 commit comments

Comments
 (0)