Skip to content

Commit 1fbca24

Browse files
committed
docs: improve docker installation section
1 parent e46de45 commit 1fbca24

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

installation.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,45 @@ Be sure to read [What's Stochastix?](/introduction.md) page to understand the fr
66

77
## Docker Installation <Badge type="tip" text="Recommended" />
88

9-
::: tip The Easy Way
10-
This is the fastest and easiest way to get started with a fresh Stochastix project. The installer handles the creation of a new Symfony application, installation of the Stochastix bundle, and Docker configuration in a single command.
9+
This is the fastest and easiest way to get started with a fresh Stochastix project. You do not need any prior knowledge of Docker to use this method; you just need to have Docker Desktop installed on your system.
10+
11+
::: info Prerequisites
12+
13+
1. **Install Docker Desktop**: Download and install the version for your operating system from the official website.
14+
15+
* [**Download Docker Desktop**](https://www.docker.com/products/docker-desktop/)
16+
17+
2. **(Windows Users Only) Install WSL 2**: Docker Desktop on Windows requires the Windows Subsystem for Linux (WSL) 2 backend. If you don't have it installed, follow the official Microsoft guide.
18+
19+
* [**Microsoft's Guide to Installing WSL**](https://learn.microsoft.com/en-us/windows/wsl/install)
1120
:::
1221

13-
Open your terminal and run the following command. Replace `your-project-name` with the desired directory name for your new project.
22+
### Run the Installer
23+
24+
Once Docker Desktop is installed and running, open your terminal and run the following command. Replace `your-project-name` with the desired directory name for your new project.
1425

1526
```bash
1627
docker run --rm -it --pull=always -e HOST_PWD="$PWD" \
1728
-v "$PWD":/app -v /var/run/docker.sock:/var/run/docker.sock \
1829
ghcr.io/phpquant/stochastix-installer your-project-name
1930
```
2031

21-
The installer will:
32+
The installer will perform the following steps:
2233

2334
1. Create a new directory named `your-project-name`.
2435
2. Set up a new Symfony project inside it.
2536
3. Install the `stochastix/core` bundle and its dependencies.
26-
4. Create `compose.yaml` file for a ready-to-use development environment.
37+
4. Create a `compose.yaml` file for a ready-to-use development environment.
38+
39+
### First Launch
2740

2841
Once the process is complete, your Stochastix environment is now running and ready for use.
2942

30-
You can access https://localhost in your web browser to access the user interface.
43+
You can access **https://localhost** in your web browser to access the user interface.
3144

32-
Next step: visit the [Docker tooling](/docker-tooling.md) page to understand how to manage your Docker environment, including starting and stopping the containers, and launching commands inside the container.
45+
::: tip Next Step
46+
Visit the [Docker tooling](/docker-tooling) page to understand how to manage your Docker environment and run commands.
47+
:::
3348

3449
## Manual Installation
3550

0 commit comments

Comments
 (0)