Add local environment setup guide to QA strategy#286
Add local environment setup guide to QA strategy#286lubomirw merged 10 commits intodocumentationfrom
Conversation
…cker Compose - Add warning that Local API returns 401 when called from host machine - Add docker exec example for Docker Compose deployments - Clarify standalone vs Docker Compose usage for both curl and wget examples - Fix curl example: https -> http (Local API does not use TLS) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Step-by-step guide for setting up the ILM platform locally using Docker Compose. Covers all non-obvious steps discovered during hands-on testing: - correct repos to clone and required folder names - trusted_certificates.pem must exist before docker compose up - Dummy Root CA required for certificate authentication - Local API only accessible via docker exec (not from host) - ssl-client-cert header with URL-encoded certificate for API auth Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add Node.js 18+ to prerequisites - Clone fe-administrator repo in Step 1 - Add Step 8: start Administrator frontend (Vite dev server on localhost:5173) - Document how to generate setupProxy.js with URL-encoded dummy cert - Add Step 9 stop instructions for both frontend and backend - Add frontend troubleshooting entries Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Hi @rud3ka , I believe this should be part of https://github.com/OmniTrustILM/development-environment. In case it is needed here, I would keep it only as link to development-environment to avoid future conflicts when the development-environment will be updated and duplicated information. |
|
Hi @3keyroman! Thank you for the feedback! I'd like to share a few reasons why I believe this guide belongs here. This is the start of our QA documentation space. The The audience is different. The development-environment README is written for developers who already know the system. This guide is written for someone who is setting up the platform for the first time specifically to write tests — a QA candidate or a new team member. The tone, level of detail, and goal are different. We filled in the blanks. We went through the setup hands-on and discovered several missing or incorrect steps — the trusted CA setup, the URL-encoding requirement for the certificate, the Happy to discuss further — but I think keeping this guide here serves the QA team and candidates in a way the README alone doesn't. |
lubomirw
left a comment
There was a problem hiding this comment.
Code review: 2 issue(s) found.
…instead of urllib
After discussion with @rud3ka, we will keep it as part of QA documentation for now. Consolidation and refactoring of QA-dedicated section of documentation would be anyway necessary and part of that will be also changes regarding environment setup. |
Summary
Adds a step-by-step local environment setup guide to the QA Strategy section.
The guide was written based on hands-on testing of the Docker Compose setup and covers all non-obvious steps that are missing or incorrect in the current
development-environmentREADME.Key things documented:
secrets/trusted_certificates.pemmust exist beforedocker compose up/api/v1/local/admins) is only accessible viadocker exec— not from the host machinessl-client-certheader requires URL-encoded certificate valueWhy this belongs in QA Strategy
This guide serves as the entry point for anyone setting up the platform for testing — including new QA engineers and candidates completing take-home assignments. Having it in the QA Strategy section establishes it as the authoritative setup reference for testing purposes.
Test plan
healthystatusdocker execssl-client-certheader🤖 Generated with Claude Code