Skip to content
Merged
Changes from all commits
Commits
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
43 changes: 27 additions & 16 deletions installation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,50 @@

## Introduction

This installation guide provides step-by-step instructions for installing Mage-OS on your server. The guide assumes

Check failure on line 13 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:13:81 MD013/line-length Line length [Expected: 80; Actual: 115] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
you have a basic understanding of programming concepts, specifically PHP and Magento 2. By following these instructions,

Check failure on line 14 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:14:81 MD013/line-length Line length [Expected: 80; Actual: 120] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
you will be able to successfully install Mage-OS and start building your online store.

## Prerequisites

Before installation, ensure your server fulfills the following requirements:

- PHP: 8.1 to 8.3
- Database: MySQL 8.0 or MariaDB 10.6
- Search Engine: Elasticsearch 7, 8, or OpenSearch 2.5+
- Web Server: Apache 2.4 or nginx 1.24
- Composer 2.7+

**Recommended (Optional):**

- RabbitMQ 3.11
- Redis 7.0
- Varnish 7.3

For AWS users, consider using [AWS ElastiCache](<(https://aws.amazon.com/elasticache/)>) and other services for
compatibility.
Please see the system requirements by version below.

### Recommended software by version

| Software | 2.0.0 |
| ------------- |-------------------------|
| PHP | 8.4, 8.3 |
| Composer | 2.8.8 |
| Database | mariadb:11.4, myqsl:8.4 |
| Search engine | OS:3 |
| RabbitMQ | 4.1 |
| Valkey | 8 |
| Varnish | 7.7 |
| Nginx | 1.28 |
| OS | ubuntu-latest |
| Release Date | 2025-10-16 |

| Software | 1.3.1 | 1.3.0 |
| ------------- |-------------------------|-------------------------|
| PHP | 8.4, 8.3 | 8.4, 8.3 |
| Composer | 2.8.8 | 2.8.8 |
| Database | mariadb:11.4, myqsl:8.4 | mariadb:11.4, myqsl:8.4 |
| Search engine | OS:3 | OS:3 |
| RabbitMQ | 4.1 | 4.1 |
| Valkey | 8 | 8 |
| Varnish | 7.7 | 7.7 |
| Nginx | 1.28 | 1.28 |
| OS | ubuntu-latest | ubuntu-latest |
| Release Date | 2025-09-09 | 2025-08-13 |

| Software | 1.2.0 | 1.1.1 | 1.1.0 | 1.0.6 | 1.0.5 |

Check failure on line 49 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:49:81 MD013/line-length Line length [Expected: 80; Actual: 97] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
| ------------- | ------------- | ------------- | ------------- | ------------- | ------------- |

Check failure on line 50 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:50:81 MD013/line-length Line length [Expected: 80; Actual: 97] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
| PHP | 8.4 | 8.4 | 8.4 | 8.3 | 8.3 |

Check failure on line 51 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:51:81 MD013/line-length Line length [Expected: 80; Actual: 97] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
| Composer | 2.8.8 | 2.8.8 | 2.8.8 | 2.7.4 | 2.7.4 |

Check failure on line 52 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:52:81 MD013/line-length Line length [Expected: 80; Actual: 97] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
| Database | mariadb:10.6 | mariadb:10.6 | mariadb:10.6 | mariadb:10.6 | mariadb:10.6 |

Check failure on line 53 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:53:81 MD013/line-length Line length [Expected: 80; Actual: 97] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
| Search engine | OS:2.19.1 | OS:2.19.1 | OS:2.19.1 | ES 8.11.4 | ES 8.11.4 |

Check failure on line 54 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:54:81 MD013/line-length Line length [Expected: 80; Actual: 97] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
| RabbitMQ | 4.0 | 4.0 | 4.0 | 3.13 | 3.13 |

Check failure on line 55 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:55:81 MD013/line-length Line length [Expected: 80; Actual: 97] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
| Redis | 7.2 | 7.2 | 7.2 | 7.2 | 7.2 |

Check failure on line 56 in installation-guide.md

View workflow job for this annotation

GitHub Actions / lint

Line length

installation-guide.md:56:81 MD013/line-length Line length [Expected: 80; Actual: 97] https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md013.md
| Varnish | 7.6 | 7.6 | 7.6 | 7.5 | 7.5 |
| Nginx | 1.26 | 1.26 | 1.26 | 1.26 | 1.26 |
| OS | ubuntu-latest | ubuntu-latest | ubuntu-latest | ubuntu-latest | ubuntu-latest |
Expand Down