Skip to content

docs: add Windows setup notes #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
tomatotomata wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: add Windows setup notes #494

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/docs/getting_started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,31 @@
docker-compose up -d ingestion read
```

### Windows notes

The same stack can be started from PowerShell when Docker Desktop is running.
Use the current Compose subcommand spelling shown below:

```powershell
docker compose up -d mongodb neo4j postgres
docker compose up -d core
docker compose up -d ingestion read
```

Before starting the services, confirm that Docker Desktop's Linux engine is
running. `docker compose config --quiet` can validate the Compose file without
starting containers. The repository's `run_e2e.sh` script is POSIX shell
syntax, so run it from WSL or Git Bash rather than native PowerShell:

```bash
cd opengin/tests/e2e
bash ./run_e2e.sh
```

Go 1.19+ and Ballerina are also required by the CORE and API services. They
must be installed separately on Windows and available on `PATH` before using
the non-container development commands.

### Test the System

**Run E2E tests**
Expand Down
Loading