Skip to content

Commit

Permalink
Merge pull request #469 from spryker/feature/sc-17030/orbstack
Browse files Browse the repository at this point in the history
[DOCS] [SC-17030]: Orbstack
  • Loading branch information
andriitserkovnyi authored Dec 5, 2023
2 parents 448cc23 + 81ebb49 commit c855fbc
Showing 1 changed file with 33 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,31 +13,52 @@ Review the minimum system requirements in the table:
| RAM: 4GB | This is a minimum requirement. The value can be higher than 4GB. A lower value is not sufficient for installation purposes. |
| Swap: 2GB | This is a minimum requirement. The value can be higher than 2GB. A lower value is not sufficient for installation purposes. |

## Install and configure a Docker manager

You can run Spryker in Docker using Docker Desktop or OrbStack. Docker Desktop is a free default tool, but OrbStack works faster with intel-based Macs.


### Install Docker Desktop

1. Download and install [Docker Desktop (Mac)](https://docs.docker.com/desktop/mac/install/).

{% info_block infoBox %}

Signup for Docker Hub is not required.

{% endinfo_block %}

## Installing and configuring required software
Follow the steps to install and configure the required software:
1. Download and install [Docker Desktop (Mac)](https://desktop.docker.com/mac/stable/amd64/Docker.dmg).
2. Accept the privilege escalation request "Docker Desktop needs privileged access.".
@(Info)()(Signup for Docker Hub is not required.)

3. Go to ![whale](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Installation/Spryker+in+Docker/Docker+Install+Prerequisites+-+MacOS/whale-x.png) > **Preferences** > **Command Line** and **Enable experimental features**.
3. In the Docker Desktop, go to preferences by selecting the gear in the top right corner.

4. In the **General** section of **Preferences**, click the **Use Docker Compose V2** checkbox.

4. Update Memory and Swap Limits:
5. Set recommended memory and swap limits:

1. Go to![whale](https://spryker.s3.eu-central-1.amazonaws.com/docs/Developer+Guide/Installation/Spryker+in+Docker/Docker+Install+Prerequisites+-+MacOS/whale-x.png) > **Preferences** > **Resources** > **ADVANCED**.
1. Go to **Resources** > **ADVANCED**.
2. Set **CPUs:** to "4" or higher.
3. Set **Memory:** to "4.00 GB" or higher.
4. Set **Swap:** to "2.00 GB" or higher.
5. Set the desired **Disk image size:**.
6. Select the desired **Disk image location**.
7. Click **Apply & Restart**.
7. Select **Apply & Restart**.

### Install OrbStack

Download and install [OrbStack](https://orbstack.dev/download).


To migrate from Docker Desktop to OrbStack, see [Migrate from Docker to OrbStack](https://docs.orbstack.dev/install#docker-migration).
To run Docker Desktop and OrbStack side-by-side and switch between them, see [Side-by-side
](https://docs.orbstack.dev/install#docker-context).

## Install Mutagen for development mode

@(Warning)()(You can set lower **Memory:** and **Swap:** limit values. However, the default limits won't be sufficient to run the application, so make sure to increase them. )
If you are going to run Spryker in [development mode](../02-installation-guides/01-choosing-an-installation-mode.md#development-mode), install or update Mutagen and Mutagen Compose to the latest version:

5. [Development mode](../02-installation-guides/01-choosing-an-installation-mode.md#development-mode): Install Mutagen:
```shell
brew list | grep mutagen | xargs brew remove && brew install mutagen-io/mutagen/mutagen mutagen-io/mutagen/mutagen-compose && mutagen daemon stop && mutagen daemon start
```bash
brew list | grep mutagen | xargs brew remove && brew install mutagen-io/mutagen/mutagen mutagen-io/mutagen/mutagen-compose && mutagen daemon stop && mutagen daemon start
```

## Next steps
Expand Down

0 comments on commit c855fbc

Please sign in to comment.