Skip to content

Commit

Permalink
[Docs] Minimum requirements adjustments (#361)
Browse files Browse the repository at this point in the history
* [Docs] Minimum requirements adjustments

* Updated install documentation for windows and linux

Co-authored-by: Filip Sushko <[email protected]>
  • Loading branch information
alexanderM91 and zyuzka authored Sep 21, 2022
1 parent 8d81c2a commit 765d229
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Follow the steps to install and configure the required software:

5. [Development mode](../02-installation-guides/01-choosing-an-installation-mode.md#development-mode): Install Mutagen:
```shell
brew install mutagen-io/mutagen/mutagen-beta
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
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Review the minimum system requirements in the table:

## Installing and configuring required software
Follow the steps to install and configure the required software:
1. Download and install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/) for Linux.
1. Download and install [Docker](https://docs.docker.com/engine/install/ubuntu/#installation-methods) for Linux.
@(Info)()(Signup for Docker Hub is not required.)

2. Enable BuildKit by creating or updating `/etc/docker/daemon.json`:
Expand All @@ -30,17 +30,20 @@ Follow the steps to install and configure the required software:
```
3. Restart Docker:
```shell
/etc/init.d/docker restart
sudo service docker start
```
4. Optional: Configure the `docker` group to manage Docker as a non-root user. See [Manage Docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user) for configuration instructions.

5. Install Docker-compose:
```shell
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
mkdir -p $DOCKER_CONFIG/cli-plugins
curl -SL https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose
chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose
```
6. Apply executable permissions to the binary:
6. Check Docker-compose version:
```shell
sudo chmod +x /usr/local/bin/docker-compose
docker compose version
```

You've installed and configured the required software.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -153,11 +153,14 @@ sudo apt-get install docker-ce docker-ce-cli containerd.io
Install Docker Compose:
1. Download the current stable release of Docker Compose:
```bash
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
DOCKER_CONFIG=${DOCKER_CONFIG:-$HOME/.docker}
mkdir -p $DOCKER_CONFIG/cli-plugins
curl -SL https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-linux-x86_64 -o $DOCKER_CONFIG/cli-plugins/docker-compose
chmod +x $DOCKER_CONFIG/cli-plugins/docker-compose
```
2. Apply executable permissions to the binary:
2. Check Docker-compose version:
```bash
sudo chmod +x /usr/local/bin/docker-compose
docker compose version
```

### Install docker-sync
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Make sure that you are in the correct folder by running the `pwd` command.
5. In `deploy.dev.yml`, define `image:` with the PHP image compatible with the current release of the Demo Shop:
```yaml
image: spryker/php:7.3-alpine3.12
image: spryker/php:7.4-alpine3.16
```
6. Clone the Docker SDK repository:
Expand All @@ -56,16 +56,16 @@ git clone https://github.com/spryker/docker-sdk.git --single-branch docker
```
:::(Warning) (Verification)
Make sure `docker 18.09.1+` and `docker-compose 1.23+` are installed:
Make sure `docker 18.09.1+` and `docker compose 2+` are installed:
```bash
$ docker version
$ docker-compose --version
$ docker compose version
```
:::
7. Bootstrap local docker setup:
```bash
docker/sdk bootstrap deploy.dev.yml
```
Expand All @@ -80,7 +80,7 @@ To double-check if there are any instructions, run `docker/sdk install`.
:::

9. Build and start the instance:

```bash
docker/sdk up
```
Expand All @@ -92,7 +92,7 @@ docker/sdk up
To ensure that the installation is successful, make sure you can access the configured endpoints from the Deploy file. See [Deploy file reference - 1.0](../../99-deploy.file.reference.v1.md) to learn about the Deploy file.

:::(Info) (RabbitMQ UI credentials)
To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`.
To access RabbitMQ UI, use `spryker` as a username and `secret` as a password. You can adjust the credentials in `deploy.yml`.
:::

## Getting the list of useful commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Make sure that you are in the correct folder by running the `pwd` command.
6. In `deploy.dev.yml`, define `image:` with the PHP image compatible with the current release of the Demo Shop:
```yaml
image: spryker/php:7.3-alpine3.12
image: spryker/php:7.4-alpine3.16
```
7. Clone the Docker SDK repository:
Expand All @@ -55,11 +55,11 @@ git clone https://github.com/spryker/docker-sdk.git --single-branch docker
```
:::(Warning) (Verification)
Make sure `docker 18.09.1+` and `docker-compose 1.23+` are installed:
Make sure `docker 18.09.1+` and `docker compose 2+` are installed:
```bash
$ docker version
$ docker-compose --version
$ docker compose version
```
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ Make sure that you are in the correct folder by running the `pwd` command.
git clone [email protected]:spryker/docker-sdk.git --single-branch docker
```
:::(Warning) (Verification)
Make sure `docker 18.09.1+` and `docker-compose 1.23+` are installed:
Make sure `docker 18.09.1+` and `docker compose 2+` are installed:

```bash
$ docker version
$ docker-compose --version
$ docker compose version
```
:::

Expand All @@ -78,7 +78,7 @@ You can run `docker/sdk install` after `bootstrap` to get the list of the instru
:::
8. Once the job finishes, build and start the instance:
```shell
docker/sdk up
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ Make sure that you are in the correct folder by running the `pwd` command.
git clone [email protected]:spryker/docker-sdk.git --single-branch docker
```
:::(Warning) (Verification)
Make sure `docker 18.09.1+` and `docker-compose 1.23+` are installed:
Make sure `docker 18.09.1+` and `docker compose 2+` are installed:

```bash
$ docker version
$ docker-compose --version
$ docker compose version
```
:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ Follow the steps to install the Docker SDK:
git clone https://github.com/spryker/docker-sdk.git ./docker
```
:::(Warning) (Verification)
Make sure `docker 18.09.1+` and `docker-compose 1.23+` are installed:
Make sure `docker 18.09.1+` and `docker compose 2+` are installed:

```bash
$ docker version
$ docker-compose --version
$ docker compose version
```
:::

Expand Down

0 comments on commit 765d229

Please sign in to comment.