diff --git a/charts/netapp-copilot-connector/README.md b/charts/netapp-copilot-connector/README.md index 6f9adb9..1f6fd13 100644 --- a/charts/netapp-copilot-connector/README.md +++ b/charts/netapp-copilot-connector/README.md @@ -914,7 +914,7 @@ helm uninstall netapp-connector --namespace netapp-connector | `postgresql.image.tag` | PostgreSQL image tag. | `16.10-alpine3.21` | | `postgresql.image.pullPolicy` | PostgreSQL image pull policy. | `IfNotPresent` | | `postgresql.auth.username` | PostgreSQL username. | `postgres` | -| `postgresql.auth.password` | PostgreSQL password. **Should be changed for production.** | `neodbsecret` | +| `postgresql.auth.password` | PostgreSQL password. **Should be changed for production.** | `YOUR_DB_PASSWORD_HERE` | | `postgresql.auth.database` | PostgreSQL database name. | `netappconnector` | | `postgresql.service.type` | PostgreSQL service type. | `ClusterIP` | | `postgresql.service.port` | PostgreSQL service port. | `5432` | diff --git a/charts/netapp-copilot-connector/values.yaml b/charts/netapp-copilot-connector/values.yaml index 3d8fc12..ec8a3d1 100644 --- a/charts/netapp-copilot-connector/values.yaml +++ b/charts/netapp-copilot-connector/values.yaml @@ -57,7 +57,7 @@ postgresql: # Database credentials auth: username: postgres - password: neodbsecret + password: YOUR_DB_PASSWORD_HERE database: netappconnector service: type: ClusterIP diff --git a/docs/projects/mlai/neo/core/legacy.md b/docs/projects/mlai/neo/core/legacy.md index d279b95..c6a4185 100644 --- a/docs/projects/mlai/neo/core/legacy.md +++ b/docs/projects/mlai/neo/core/legacy.md @@ -370,8 +370,8 @@ HTTPS_PROXY=http://proxy.company.com:8080 HTTP_PROXY=http://proxy.company.com:8080 # Proxy authentication (optional) -PROXY_USERNAME=proxy_user -PROXY_PASSWORD=proxy_password +PROXY_USERNAME=YOUR_PROXY_USERNAME_HERE +PROXY_PASSWORD=YOUR_PROXY_PASSWORD_HERE # SSL configuration GRAPH_VERIFY_SSL=true diff --git a/docs/projects/mlai/neo/core/m-acls.md b/docs/projects/mlai/neo/core/m-acls.md index d3783a8..e133eed 100644 --- a/docs/projects/mlai/neo/core/m-acls.md +++ b/docs/projects/mlai/neo/core/m-acls.md @@ -37,7 +37,7 @@ POST /shares { "share_path": "\\\\fileserver\\public-documents", "username": "domain\\serviceaccount", - "password": "your-password", + "password": "YOUR_PASSWORD_HERE", "crawl_schedule": "0 2 * * *", "rules": { "acl_override_mode": "everyone" @@ -56,7 +56,7 @@ POST /shares { "share_path": "\\\\fileserver\\department-files", "username": "domain\\serviceaccount", - "password": "your-password", + "password": "YOUR_PASSWORD_HERE", "crawl_schedule": "0 2 * * *", "rules": { "acl_override_mode": "specified", @@ -164,7 +164,7 @@ ACL overrides can be combined with other share rules: { "share_path": "\\\\fileserver\\documents", "username": "domain\\serviceaccount", - "password": "your-password", + "password": "YOUR_PASSWORD_HERE", "rules": { "acl_override_mode": "specified", "acl_override_principals": [ diff --git a/docs/projects/mlai/neo/core/m-mcp.md b/docs/projects/mlai/neo/core/m-mcp.md index 339a567..56e9965 100644 --- a/docs/projects/mlai/neo/core/m-mcp.md +++ b/docs/projects/mlai/neo/core/m-mcp.md @@ -205,9 +205,9 @@ Add these to your `.env` file or container environment: ```bash # OAuth Configuration (Required for MCP) MCP_OAUTH_ENABLED=true -MCP_OAUTH_TENANT_ID=your-tenant-id # Microsoft Entra tenant ID -MCP_OAUTH_CLIENT_ID=your-client-id # App registration client ID -MCP_OAUTH_CLIENT_SECRET=your-client-secret # App registration secret +MCP_OAUTH_TENANT_ID=YOUR_TENANT_ID_HERE # Microsoft Entra tenant ID +MCP_OAUTH_CLIENT_ID=YOUR_CLIENT_ID_HERE # App registration client ID +MCP_OAUTH_CLIENT_SECRET=YOUR_CLIENT_SECRET_HERE # App registration secret # Optional: Rate Limiting Configuration MCP_RATE_LIMIT_SEARCH=30 # search_files requests per minute @@ -265,8 +265,8 @@ This method allows Claude Desktop to handle OAuth automatically. Edit your Claud "netapp-files": { "url": "http://localhost:8080/mcp", "oauth": { - "client_id": "your-client-id", - "client_secret": "your-client-secret", + "client_id": "YOUR_CLIENT_ID_HERE", + "client_secret": "YOUR_CLIENT_SECRET_HERE", "authorization_url": "http://localhost:8080/authorize", "token_url": "http://localhost:8080/token", "scopes": ["openid", "profile", "email"] @@ -327,10 +327,10 @@ For development or when HTTP transport isn't available: "env": { "NETAPP_API_URL": "http://localhost:8080", "MCP_OAUTH_ENABLED": "true", - "MCP_OAUTH_TENANT_ID": "your-tenant-id", - "MCP_OAUTH_CLIENT_ID": "your-client-id", - "MCP_OAUTH_CLIENT_SECRET": "your-client-secret", - "MCP_OAUTH_TOKEN": "your-user-oauth-token" + "MCP_OAUTH_TENANT_ID": "YOUR_TENANT_ID_HERE", + "MCP_OAUTH_CLIENT_ID": "YOUR_CLIENT_ID_HERE", + "MCP_OAUTH_CLIENT_SECRET": "YOUR_CLIENT_SECRET_HERE", + "MCP_OAUTH_TOKEN": "YOUR_OAUTH_TOKEN_HERE" } } } @@ -372,7 +372,7 @@ curl -X POST "http://localhost:8080/auth/device/poll?device_code=YOUR_DEVICE_COD ```bash az login -az account get-access-token --resource api://your-client-id --query accessToken -o tsv +az account get-access-token --resource api://YOUR_CLIENT_ID_HERE --query accessToken -o tsv ``` --- @@ -544,7 +544,7 @@ There are two ways to configure an MCP API key: Set the `MCP_API_KEY` environment variable in your deployment: ```bash -MCP_API_KEY=your-secret-api-key +MCP_API_KEY=YOUR_MCP_API_KEY_HERE ``` This takes precedence over any key stored in the database. @@ -741,9 +741,9 @@ When rate limited, tools return: ```bash MCP_OAUTH_ENABLED=true -MCP_OAUTH_TENANT_ID=your-tenant-id -MCP_OAUTH_CLIENT_ID=your-client-id -MCP_OAUTH_CLIENT_SECRET=your-client-secret +MCP_OAUTH_TENANT_ID=YOUR_TENANT_ID_HERE +MCP_OAUTH_CLIENT_ID=YOUR_CLIENT_ID_HERE +MCP_OAUTH_CLIENT_SECRET=YOUR_CLIENT_SECRET_HERE ``` #### 2\. "Token validation failed" diff --git a/docs/projects/mlai/neo/core/m-protocols.md b/docs/projects/mlai/neo/core/m-protocols.md index ba5190f..382ed39 100644 --- a/docs/projects/mlai/neo/core/m-protocols.md +++ b/docs/projects/mlai/neo/core/m-protocols.md @@ -79,7 +79,7 @@ curl -s -X POST -H "Authorization: Bearer $TOKEN" \ "protocol": "smb", "share_path": "//fileserver01/shared-docs", "username": "svc-neo", - "password": "SecureP@ssw0rd", + "password": "YOUR_PASSWORD_HERE", "domain": "CORP" }' \ "http://localhost:8000/api/v1/shares?crawl_immediately=true" @@ -94,7 +94,7 @@ curl -s -X POST -H "Authorization: Bearer $TOKEN" \ "protocol": "smb", "share_path": "//nas.corp.com/finance", "username": "svc-neo", - "password": "SecureP@ssw0rd", + "password": "YOUR_PASSWORD_HERE", "domain": "CORP", "crawl_schedule": "0 2 * * 0", "rules": { @@ -226,7 +226,7 @@ curl -s -X POST -H "Authorization: Bearer $TOKEN" \ "nfs_version": "4", "nfs_security": "krb5i", "username": "svc-neo@CORP.COM", - "password": "kerberos-password" + "password": "YOUR_KERBEROS_PASSWORD_HERE" }' \ "http://localhost:8000/api/v1/shares" ``` @@ -352,8 +352,8 @@ curl -s -X POST -H "Authorization: Bearer $TOKEN" \ -d '{ "protocol": "s3", "share_path": "s3://company-documents", - "username": "AKIAIOSFODNN7EXAMPLE", - "password": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "username": "YOUR_AWS_ACCESS_KEY_HERE", + "password": "YOUR_AWS_SECRET_KEY_HERE", "s3_region": "us-east-1" }' \ "http://localhost:8000/api/v1/shares?crawl_immediately=true" @@ -367,8 +367,8 @@ curl -s -X POST -H "Authorization: Bearer $TOKEN" \ -d '{ "protocol": "s3", "share_path": "s3://grid-archive/legal", - "username": "GRIDACCESSKEY", - "password": "GRIDSECRETKEY", + "username": "YOUR_GRID_ACCESS_KEY_HERE", + "password": "YOUR_GRID_SECRET_KEY_HERE", "s3_endpoint_url": "https://s3.storagegrid.company.com:8082", "s3_region": "us-east-1", "s3_use_ssl": true @@ -384,8 +384,8 @@ curl -s -X POST -H "Authorization: Bearer $TOKEN" \ -d '{ "protocol": "s3", "share_path": "s3://test-bucket", - "username": "minioadmin", - "password": "minioadmin", + "username": "YOUR_MINIO_ACCESS_KEY_HERE", + "password": "YOUR_MINIO_SECRET_KEY_HERE", "s3_endpoint_url": "http://minio.local:9000", "s3_region": "us-east-1", "s3_use_ssl": false @@ -401,8 +401,8 @@ curl -s -X POST -H "Authorization: Bearer $TOKEN" \ -d '{ "protocol": "s3", "share_path": "s3://prod-data-lake/customer-docs", - "username": "AKIAIOSFODNN7EXAMPLE", - "password": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "username": "YOUR_AWS_ACCESS_KEY_HERE", + "password": "YOUR_AWS_SECRET_KEY_HERE", "s3_region": "eu-west-1", "crawl_schedule": "0 1 * * 0", "rules": { diff --git a/docs/projects/mlai/neo/core/m-shares.md b/docs/projects/mlai/neo/core/m-shares.md index d1bc6af..536063e 100644 --- a/docs/projects/mlai/neo/core/m-shares.md +++ b/docs/projects/mlai/neo/core/m-shares.md @@ -152,8 +152,8 @@ curl -X POST "http://localhost:8000/api/v1/shares?crawl_immediately=true" \ -d '{ "protocol": "s3", "share_path": "s3://my-documents/reports", - "username": "AKIAIOSFODNN7EXAMPLE", - "password": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "username": "YOUR_AWS_ACCESS_KEY_HERE", + "password": "YOUR_AWS_SECRET_KEY_HERE", "s3_bucket": "my-documents", "s3_prefix": "reports/", "s3_region": "us-east-1", diff --git a/docs/projects/mlai/neo/core/m-users.md b/docs/projects/mlai/neo/core/m-users.md index ede76c3..130d609 100644 --- a/docs/projects/mlai/neo/core/m-users.md +++ b/docs/projects/mlai/neo/core/m-users.md @@ -119,8 +119,8 @@ curl -s -X PATCH http://localhost:8000/api/v1/users/me/password \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "current_password": "oldP@ssw0rd", - "new_password": "newS3cur3P@ss!" + "current_password": "YOUR_CURRENT_PASSWORD_HERE", + "new_password": "YOUR_NEW_PASSWORD_HERE" }' ``` @@ -207,7 +207,7 @@ curl -s -X POST http://localhost:8000/api/v1/users \ -H "Content-Type: application/json" \ -d '{ "username": "analyst", - "password": "An@lyst2026!", + "password": "YOUR_PASSWORD_HERE", "email": "analyst@example.com", "is_admin": false }' @@ -334,7 +334,7 @@ curl -s -X POST http://localhost:8000/api/v1/users/admin \ -H "Content-Type: application/json" \ -d '{ "username": "backup_admin", - "password": "B@ckup2026!" + "password": "YOUR_PASSWORD_HERE" }' ``` @@ -361,7 +361,7 @@ curl -s http://localhost:8000/api/v1/setup/initial-credentials | jq ```json { "username": "admin", - "password": "aB3$kL9mNpQ2", + "password": "YOUR_AUTO_GENERATED_PASSWORD_HERE", "message": "Please change this password immediately after logging in. This endpoint will be disabled after first login." } ``` @@ -383,7 +383,7 @@ curl -s http://localhost:8000/api/v1/setup/initial-credentials | jq 3. Authenticate with the initial credentials: ```bash TOKEN=$(curl -s -X POST http://localhost:8000/api/v1/token \ - -d "username=admin&password=aB3\$kL9mNpQ2" | jq -r .access_token) + -d "username=admin&password=YOUR_AUTO_GENERATED_PASSWORD_HERE" | jq -r .access_token) ``` 4. Change the admin password immediately: ```bash @@ -391,8 +391,8 @@ curl -s http://localhost:8000/api/v1/setup/initial-credentials | jq -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ - "current_password": "aB3$kL9mNpQ2", - "new_password": "YourSecurePassword!" + "current_password": "YOUR_AUTO_GENERATED_PASSWORD_HERE", + "new_password": "YOUR_NEW_PASSWORD_HERE" }' ``` 5. Create additional user accounts as needed using the admin endpoints above. diff --git a/docs/projects/mlai/neo/core/qs-docker.md b/docs/projects/mlai/neo/core/qs-docker.md index fcc7be8..758cd1e 100644 --- a/docs/projects/mlai/neo/core/qs-docker.md +++ b/docs/projects/mlai/neo/core/qs-docker.md @@ -60,7 +60,7 @@ Neo can be fully configured after startup via the UI or API. However, if you pre ```bash # Database credentials (defaults shown) POSTGRES_USER=neo -POSTGRES_PASSWORD=neo_password +POSTGRES_PASSWORD=YOUR_DB_PASSWORD_HERE POSTGRES_DB=neo_connector # License key (can also be set via UI/API during setup) @@ -181,9 +181,9 @@ curl -X POST http://localhost:8000/api/v1/setup/license \ curl -X POST http://localhost:8000/api/v1/setup/graph \ -H "Content-Type: application/json" \ -d '{ - "tenant_id": "your-tenant-id", - "client_id": "your-client-id", - "client_secret": "your-client-secret" + "tenant_id": "YOUR_TENANT_ID_HERE", + "client_id": "YOUR_CLIENT_ID_HERE", + "client_secret": "YOUR_CLIENT_SECRET_HERE" }' ``` diff --git a/docs/projects/mlai/neo/core/qs-kubernetes.md b/docs/projects/mlai/neo/core/qs-kubernetes.md index 43d669b..787b415 100644 --- a/docs/projects/mlai/neo/core/qs-kubernetes.md +++ b/docs/projects/mlai/neo/core/qs-kubernetes.md @@ -74,7 +74,7 @@ helm install netapp-neo innovation-labs/netapp-neo \ --namespace netapp-neo \ --create-namespace \ --set postgresql.enabled=true \ - --set postgresql.auth.password="your-secure-password" \ + --set postgresql.auth.password="YOUR_DB_PASSWORD_HERE" \ --set postgresql.auth.database="neo_connector" ``` @@ -89,7 +89,7 @@ helm install netapp-neo innovation-labs/netapp-neo \ --create-namespace \ --set postgresql.enabled=false \ --set api.env.DB_TYPE="postgres" \ - --set api.env.DATABASE_URL="postgresql://user:password@external-host:5432/neo_connector" + --set api.env.DATABASE_URL="postgresql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@external-host:5432/neo_connector" ``` @@ -111,7 +111,7 @@ postgresql: enabled: true auth: username: postgres - password: "your-secure-password" + password: "YOUR_DB_PASSWORD_HERE" database: neo_connector persistence: enabled: true @@ -174,9 +174,9 @@ api: # --- External Database Configuration --- env: # For PostgreSQL - DATABASE_URL: "postgresql://username@servername:password@servername.postgres.database.mydomain.com:5432/neo_connector" # parameter like ?sslmode=require could be added + DATABASE_URL: "postgresql://YOUR_DB_USER@servername:YOUR_DB_PASSWORD_HERE@servername.postgres.database.mydomain.com:5432/neo_connector" # parameter like ?sslmode=require could be added # For MySQL - # DATABASE_URL: "mysql://username:password@hostname:3306/neo_connector" + # DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@hostname:3306/neo_connector" # --- Optional API Ingress Configuration --- ingress: enabled: true @@ -191,15 +191,15 @@ api: worker: env: - DATABASE_URL: "postgresql://username@servername:password@servername.postgres.database.mydomain.com:5432/neo_connector" + DATABASE_URL: "postgresql://YOUR_DB_USER@servername:YOUR_DB_PASSWORD_HERE@servername.postgres.database.mydomain.com:5432/neo_connector" extractor: env: - DATABASE_URL: "postgresql://username@servername:password@servername.postgres.database.mydomain.com:5432/neo_connector" + DATABASE_URL: "postgresql://YOUR_DB_USER@servername:YOUR_DB_PASSWORD_HERE@servername.postgres.database.mydomain.com:5432/neo_connector" ner: env: - DATABASE_URL: "postgresql://username@servername:password@servername.postgres.database.mydomain.com:5432/neo_connector" + DATABASE_URL: "postgresql://YOUR_DB_USER@servername:YOUR_DB_PASSWORD_HERE@servername.postgres.database.mydomain.com:5432/neo_connector" ui: # --- Optional UI Ingress Configuration --- @@ -259,7 +259,7 @@ postgresql: enabled: true auth: username: postgres - password: "secure-password" + password: "YOUR_DB_PASSWORD_HERE" database: neo_connector persistence: enabled: true @@ -269,7 +269,7 @@ postgresql: **Auto-generated Connection String:** ``` -postgresql://postgres:secure-password@neo-postgres:5432/neo_connector +postgresql://postgres:YOUR_DB_PASSWORD_HERE@neo-postgres:5432/neo_connector ``` @@ -286,19 +286,19 @@ postgresql: api: env: DB_TYPE: postgres - DATABASE_URL: "postgresql://username:password@hostname:5432/neo_connector" + DATABASE_URL: "postgresql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@hostname:5432/neo_connector" worker: env: - DATABASE_URL: "postgresql://username:password@hostname:5432/neo_connector" + DATABASE_URL: "postgresql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@hostname:5432/neo_connector" extractor: env: - DATABASE_URL: "postgresql://username:password@hostname:5432/neo_connector" + DATABASE_URL: "postgresql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@hostname:5432/neo_connector" ner: env: - DATABASE_URL: "postgresql://username:password@hostname:5432/neo_connector" + DATABASE_URL: "postgresql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@hostname:5432/neo_connector" ``` **MySQL Example:** @@ -309,19 +309,19 @@ postgresql: api: env: DB_TYPE: mysql - DATABASE_URL: "mysql://username:password@hostname:3306/neo_connector" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@hostname:3306/neo_connector" worker: env: - DATABASE_URL: "mysql://username:password@hostname:3306/neo_connector" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@hostname:3306/neo_connector" extractor: env: - DATABASE_URL: "mysql://username:password@hostname:3306/neo_connector" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@hostname:3306/neo_connector" ner: env: - DATABASE_URL: "mysql://username:password@hostname:3306/neo_connector" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@hostname:3306/neo_connector" ``` **AWS RDS for PostgreSQL:** @@ -329,19 +329,19 @@ ner: api: env: DB_TYPE: postgres - DATABASE_URL: "postgresql://username:password@database-instance.xxxxx.us-east-1.rds.amazonaws.com:5432/neo_connector?sslmode=require" + DATABASE_URL: "postgresql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@database-instance.xxxxx.us-east-1.rds.amazonaws.com:5432/neo_connector?sslmode=require" worker: env: - DATABASE_URL: "postgresql://username:password@database-instance.xxxxx.us-east-1.rds.amazonaws.com:5432/neo_connector?sslmode=require" + DATABASE_URL: "postgresql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@database-instance.xxxxx.us-east-1.rds.amazonaws.com:5432/neo_connector?sslmode=require" extractor: env: - DATABASE_URL: "postgresql://username:password@database-instance.xxxxx.us-east-1.rds.amazonaws.com:5432/neo_connector?sslmode=require" + DATABASE_URL: "postgresql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@database-instance.xxxxx.us-east-1.rds.amazonaws.com:5432/neo_connector?sslmode=require" ner: env: - DATABASE_URL: "postgresql://username:password@database-instance.xxxxx.us-east-1.rds.amazonaws.com:5432/neo_connector?sslmode=require" + DATABASE_URL: "postgresql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@database-instance.xxxxx.us-east-1.rds.amazonaws.com:5432/neo_connector?sslmode=require" ``` **AWS RDS for MySQL:** @@ -349,19 +349,19 @@ ner: api: env: DB_TYPE: mysql - DATABASE_URL: "mysql://username:password@database-instance.xxxxx.us-east-1.rds.amazonaws.com:3306/neo_connector?ssl-mode=REQUIRED" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@database-instance.xxxxx.us-east-1.rds.amazonaws.com:3306/neo_connector?ssl-mode=REQUIRED" worker: env: - DATABASE_URL: "mysql://username:password@database-instance.xxxxx.us-east-1.rds.amazonaws.com:3306/neo_connector?ssl-mode=REQUIRED" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@database-instance.xxxxx.us-east-1.rds.amazonaws.com:3306/neo_connector?ssl-mode=REQUIRED" extractor: env: - DATABASE_URL: "mysql://username:password@database-instance.xxxxx.us-east-1.rds.amazonaws.com:3306/neo_connector?ssl-mode=REQUIRED" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@database-instance.xxxxx.us-east-1.rds.amazonaws.com:3306/neo_connector?ssl-mode=REQUIRED" ner: env: - DATABASE_URL: "mysql://username:password@database-instance.xxxxx.us-east-1.rds.amazonaws.com:3306/neo_connector?ssl-mode=REQUIRED" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@database-instance.xxxxx.us-east-1.rds.amazonaws.com:3306/neo_connector?ssl-mode=REQUIRED" ``` **Azure Database for PostgreSQL Flexible Server:** @@ -369,19 +369,19 @@ ner: api: env: DB_TYPE: postgres - DATABASE_URL: "postgresql://username@servername:password@servername.postgres.database.azure.com:5432/neo_connector?sslmode=require" + DATABASE_URL: "postgresql://YOUR_DB_USER@servername:YOUR_DB_PASSWORD_HERE@servername.postgres.database.azure.com:5432/neo_connector?sslmode=require" worker: env: - DATABASE_URL: "postgresql://username@servername:password@servername.postgres.database.azure.com:5432/neo_connector?sslmode=require" + DATABASE_URL: "postgresql://YOUR_DB_USER@servername:YOUR_DB_PASSWORD_HERE@servername.postgres.database.azure.com:5432/neo_connector?sslmode=require" extractor: env: - DATABASE_URL: "postgresql://username@servername:password@servername.postgres.database.azure.com:5432/neo_connector?sslmode=require" + DATABASE_URL: "postgresql://YOUR_DB_USER@servername:YOUR_DB_PASSWORD_HERE@servername.postgres.database.azure.com:5432/neo_connector?sslmode=require" ner: env: - DATABASE_URL: "postgresql://username@servername:password@servername.postgres.database.azure.com:5432/neo_connector?sslmode=require" + DATABASE_URL: "postgresql://YOUR_DB_USER@servername:YOUR_DB_PASSWORD_HERE@servername.postgres.database.azure.com:5432/neo_connector?sslmode=require" ``` **Azure Database for MySQL Flexible Server:** @@ -389,19 +389,19 @@ ner: api: env: DB_TYPE: mysql - DATABASE_URL: "mysql://username:password@servername.mysql.database.azure.com:3306/neo_connector?ssl-mode=REQUIRED" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@servername.mysql.database.azure.com:3306/neo_connector?ssl-mode=REQUIRED" worker: env: - DATABASE_URL: "mysql://username:password@servername.mysql.database.azure.com:3306/neo_connector?ssl-mode=REQUIRED" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@servername.mysql.database.azure.com:3306/neo_connector?ssl-mode=REQUIRED" extractor: env: - DATABASE_URL: "mysql://username:password@servername.mysql.database.azure.com:3306/neo_connector?ssl-mode=REQUIRED" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@servername.mysql.database.azure.com:3306/neo_connector?ssl-mode=REQUIRED" ner: env: - DATABASE_URL: "mysql://username:password@servername.mysql.database.azure.com:3306/neo_connector?ssl-mode=REQUIRED" + DATABASE_URL: "mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@servername.mysql.database.azure.com:3306/neo_connector?ssl-mode=REQUIRED" ``` > [!TIP] @@ -1099,7 +1099,7 @@ helm uninstall netapp-neo --namespace netapp-neo | `postgresql.image.tag` | PostgreSQL image tag. | `17` | | `postgresql.image.pullPolicy` | PostgreSQL image pull policy. | `IfNotPresent` | | `postgresql.auth.username` | PostgreSQL username. | `postgres` | -| `postgresql.auth.password` | PostgreSQL password. **Should be changed for production.** | `neodbsecret` | +| `postgresql.auth.password` | PostgreSQL password. **Should be changed for production.** | `YOUR_DB_PASSWORD_HERE` | | `postgresql.auth.database` | PostgreSQL database name. | `neo_connector` | | `postgresql.service.type` | PostgreSQL service type. | `ClusterIP` | | `postgresql.service.port` | PostgreSQL service port. | `5432` | diff --git a/docs/projects/mlai/neo/core/qs-podman.md b/docs/projects/mlai/neo/core/qs-podman.md index 7048c1f..02f2a04 100644 --- a/docs/projects/mlai/neo/core/qs-podman.md +++ b/docs/projects/mlai/neo/core/qs-podman.md @@ -36,14 +36,14 @@ Before deploying Neo using Podman Compose, ensure that you have the following pr ```yaml environment: - - DATABASE_URL=postgresql://postgres:yourStrongPasswordHere!@db:5432/neo + - DATABASE_URL=postgresql://postgres:YOUR_DB_PASSWORD_HERE@db:5432/neo ``` - For example, if my server's IP address is `10.100.20.05`, my username is `postgres`, the port is `5432` and my password is `yourStrongPasswordHere!`, I would set the `DATABASE_URL` as follows: + For example, if my server's IP address is `10.100.20.05`, my username is `postgres`, the port is `5432` and my password is `YOUR_DB_PASSWORD_HERE`, I would set the `DATABASE_URL` as follows: ```yaml environment: - - DATABASE_URL=postgresql://postgres:yourStrongPasswordHere!@10.100.20.05:5432/neo + - DATABASE_URL=postgresql://postgres:YOUR_DB_PASSWORD_HERE@10.100.20.05:5432/neo ``` 3. **Start the Containers**: diff --git a/docs/projects/mlai/neo/examples/NetAppConnectorforM365Copilot.postman_collection.json b/docs/projects/mlai/neo/examples/NetAppConnectorforM365Copilot.postman_collection.json index 008ec5d..448ed4e 100644 --- a/docs/projects/mlai/neo/examples/NetAppConnectorforM365Copilot.postman_collection.json +++ b/docs/projects/mlai/neo/examples/NetAppConnectorforM365Copilot.postman_collection.json @@ -492,7 +492,7 @@ ], "body": { "mode": "raw", - "raw": "{\r\n \"username\": \"admin\",\r\n \"password\": \"replacewithyourpassword\",\r\n \"email\": \"admin@example.com\"\r\n}", + "raw": "{\r\n \"username\": \"admin\",\r\n \"password\": \"YOUR_PASSWORD_HERE\",\r\n \"email\": \"admin@example.com\"\r\n}", "options": { "raw": { "language": "json" @@ -519,13 +519,13 @@ }, { "key": "Authorization", - "value": "Bearer admin_token", + "value": "Bearer YOUR_AUTH_TOKEN_HERE", "type": "text" } ], "body": { "mode": "raw", - "raw": "{\r\n \"username\": \"admin\",\r\n \"password\": \"Replacewithyourpassword\",\r\n \"email\": \"admin@example.com\"\r\n }", + "raw": "{\r\n \"username\": \"admin\",\r\n \"password\": \"YOUR_PASSWORD_HERE\",\r\n \"email\": \"admin@example.com\"\r\n }", "options": { "raw": { "language": "json" @@ -591,7 +591,7 @@ }, { "key": "password", - "value": "Replacewithyourpassword", + "value": "YOUR_PASSWORD_HERE", "type": "text" } ] diff --git a/docs/projects/mlai/neo/examples/docker-compose.example.yml b/docs/projects/mlai/neo/examples/docker-compose.example.yml index 714f1e9..42dc678 100644 --- a/docs/projects/mlai/neo/examples/docker-compose.example.yml +++ b/docs/projects/mlai/neo/examples/docker-compose.example.yml @@ -39,7 +39,7 @@ services: # POSTGRES_PASSWORD: Database superuser password. Use a strong value in # production. Change this and update DATABASE_URL references below. - POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-neo_password} + POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-YOUR_DB_PASSWORD_HERE} # POSTGRES_DB: Database name created on first startup. POSTGRES_DB: ${POSTGRES_DB:-neo_connector} @@ -70,7 +70,7 @@ services: # DATABASE_URL: PostgreSQL connection string. All services that need the # database use this. Format: postgresql://user:password@host:port/dbname - DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-neo_password}@postgres:5432/${POSTGRES_DB:-neo_connector} + DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-YOUR_DB_PASSWORD_HERE}@postgres:5432/${POSTGRES_DB:-neo_connector} # ----------------------------------------------------------------------- # Internal service communication @@ -229,7 +229,7 @@ services: environment: # DATABASE_URL: Used only at startup to retrieve the encryption key # from the system_config table (for decrypting SMB credentials). - DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-neo_password}@postgres:5432/${POSTGRES_DB:-neo_connector} + DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-YOUR_DB_PASSWORD_HERE}@postgres:5432/${POSTGRES_DB:-neo_connector} # ENCRYPTION_KEY: Same Fernet key as the API/worker. Auto-retrieved # from the database at startup if not set. Only set this to override @@ -389,7 +389,7 @@ services: # ----------------------------------------------------------------------- # Database # ----------------------------------------------------------------------- - DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-neo_password}@postgres:5432/${POSTGRES_DB:-neo_connector} + DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-YOUR_DB_PASSWORD_HERE}@postgres:5432/${POSTGRES_DB:-neo_connector} # ----------------------------------------------------------------------- # External service URLs diff --git a/docs/projects/mlai/neo/examples/env b/docs/projects/mlai/neo/examples/env index 33a1d83..14adced 100644 --- a/docs/projects/mlai/neo/examples/env +++ b/docs/projects/mlai/neo/examples/env @@ -3,7 +3,7 @@ ## Database Settings (required) POSTGRES_USER=neo -POSTGRES_PASSWORD=neo_password +POSTGRES_PASSWORD=YOUR_DB_PASSWORD_HERE POSTGRES_DB=neo_connector ## Constructed DATABASE_URL (used by all services) diff --git a/docs/projects/mlai/neo/examples/legacy-env b/docs/projects/mlai/neo/examples/legacy-env index 24ea245..9885018 100644 --- a/docs/projects/mlai/neo/examples/legacy-env +++ b/docs/projects/mlai/neo/examples/legacy-env @@ -5,17 +5,17 @@ DB_PATH=app/data/database.db # Optional: Default is data/database.db PORT=8080 # Optional: Default is 8080 # JWT configuration for authentication -JWT_SECRET_KEY=your-secret-key-here # Optional: Default is a 32-byte random key +JWT_SECRET_KEY=YOUR_JWT_SECRET_HERE # Optional: Default is a 32-byte random key JWT_ALGORITHM=HS256 # Optional: Default is HS256 ACCESS_TOKEN_EXPIRE_MINUTES=30 # Optional: Default is 30 minutes # NetApp Settings -NETAPP_CONNECTOR_LICENSE=your-licence-key-here # Mandatory +NETAPP_CONNECTOR_LICENSE=YOUR_LICENSE_KEY_HERE # Mandatory # Microsoft Graph configuration -MS_GRAPH_CLIENT_ID=your-client-id-here # Mandatory -MS_GRAPH_CLIENT_SECRET=your-client-secret-here # Mandatory -MS_GRAPH_TENANT_ID=your-tenant-id-here # Mandatory +MS_GRAPH_CLIENT_ID=YOUR_CLIENT_ID_HERE # Mandatory +MS_GRAPH_CLIENT_SECRET=YOUR_CLIENT_SECRET_HERE # Mandatory +MS_GRAPH_TENANT_ID=YOUR_TENANT_ID_HERE # Mandatory # Optional: Override default connector configuration MS_GRAPH_CONNECTOR_ID=netappcopilot # Optional: Default is netappcopilot diff --git a/docs/projects/mlai/neo/examples/legacy-neo.yml b/docs/projects/mlai/neo/examples/legacy-neo.yml index 7b636f3..cbe09eb 100644 --- a/docs/projects/mlai/neo/examples/legacy-neo.yml +++ b/docs/projects/mlai/neo/examples/legacy-neo.yml @@ -4,7 +4,7 @@ services: restart: always shm_size: 128mb # Adjust shared memory size if needed, this is important for database performance and 128mb is a good starting point for POC setups. environment: - POSTGRES_PASSWORD: password # use a strong password + POSTGRES_PASSWORD: YOUR_DB_PASSWORD_HERE # use a strong password POSTGRES_DB: neo PGDATA: /var/lib/postgresql/18/docker # PostgreSQL 18+ uses version-specific PGDATA path volumes: @@ -30,7 +30,7 @@ services: - "8081:8080" environment: - PORT=8080 - - DATABASE_URL=postgresql://postgres:password@db:5432/neo # Update with your DB credentials if needed. For mySQL use: mysql://user:password@tcp(db:3306)/neo + - DATABASE_URL=postgresql://postgres:YOUR_DB_PASSWORD_HERE@db:5432/neo # Update with your DB credentials if needed. For mySQL use: mysql://YOUR_DB_USER:YOUR_DB_PASSWORD_HERE@tcp(db:3306)/neo restart: unless-stopped networks: - netapp-neo diff --git a/docs/projects/mlai/neo/examples/neo-containerfile.yml b/docs/projects/mlai/neo/examples/neo-containerfile.yml index 121070c..6c49244 100644 --- a/docs/projects/mlai/neo/examples/neo-containerfile.yml +++ b/docs/projects/mlai/neo/examples/neo-containerfile.yml @@ -6,7 +6,7 @@ services: container_name: neo-postgres environment: POSTGRES_USER: ${POSTGRES_USER:-neo} - POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-neo_password} + POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-YOUR_DB_PASSWORD_HERE} POSTGRES_DB: ${POSTGRES_DB:-neo_connector} volumes: - postgres_data:/var/lib/postgresql/data @@ -25,7 +25,7 @@ services: ports: - "8000:8000" environment: - DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-neo_password}@postgres:5432/${POSTGRES_DB:-neo_connector} + DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-YOUR_DB_PASSWORD_HERE}@postgres:5432/${POSTGRES_DB:-neo_connector} WORKER_SERVICE_URL: http://worker:8000 NER_SERVICE_URL: http://ner:8000 JWT_SECRET_KEY: ${JWT_SECRET_KEY:-} @@ -61,7 +61,7 @@ services: image: ghcr.io/netapp/netapp-neo-extractor:4.0.2 privileged: true environment: - DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-neo_password}@postgres:5432/${POSTGRES_DB:-neo_connector} + DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-YOUR_DB_PASSWORD_HERE}@postgres:5432/${POSTGRES_DB:-neo_connector} ENCRYPTION_KEY: ${ENCRYPTION_KEY:-} EXTRACTOR_LOG_LEVEL: ${EXTRACTOR_LOG_LEVEL:-INFO} # EXTRACTOR_DEFAULT_PIPELINE: ${EXTRACTOR_DEFAULT_PIPELINE:-markitdown} @@ -116,7 +116,7 @@ services: security_opt: - apparmor:unconfined environment: - DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-neo_password}@postgres:5432/${POSTGRES_DB:-neo_connector} + DATABASE_URL: postgresql://${POSTGRES_USER:-neo}:${POSTGRES_PASSWORD:-YOUR_DB_PASSWORD_HERE}@postgres:5432/${POSTGRES_DB:-neo_connector} EXTRACTOR_SERVICE_URL: http://extractor:8000 NER_SERVICE_URL: http://ner:8000 NUM_UPLOAD_WORKERS: ${NUM_UPLOAD_WORKERS:-3}