Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit a9cf96b

Browse files
authored
Merge pull request #4469 from atwixfirster/magento-root
magento/devdocs#: Replace <your Magento install dir> with <magento_root>
2 parents 71610ba + 6334da2 commit a9cf96b

17 files changed

+450
-277
lines changed

_includes/comp-man/dependency.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,22 @@
44

55
We suggest you try the following solutions in the order shown:
66

7-
* [Conflicting dependencies](#trouble-depend-conflict)
8-
* [File system permissions issues](#trouble-depend-permission)
9-
* [The Component Dependency Check status never changes](#trouble-depend-state)
7+
* [Conflicting dependencies](#trouble-depend-conflict)
8+
* [File system permissions issues](#trouble-depend-permission)
9+
* [The Component Dependency Check status never changes](#trouble-depend-state)
1010

1111
### Conflicting dependencies {#trouble-depend-conflict}
1212

1313
The message `We found conflicting component dependencies` displays if Composer cannot determine which components to install or update. To resolve component dependency issues, you should be a technical person who thoroughly understands how Composer works.
1414

1515
Following is a sample failure message:
1616

17-
We found conflicting component dependencies.
18-
19-
You are trying to update package(s) magento/module-sample-data to 1.0.0-beta
20-
We've detected conflicts with the following packages:
21-
- magento/sample-data version 0.74.0-beta15. Please try to update it to one of the following package versions: 0.74.0-beta16, 0.74.0-beta14, 0.74.0-beta13, 0.74.0-beta12, 0.74.0-beta11, 0.74.0-beta10, 0.74.0-beta9, 0.74.0-beta8, 0.74.0-beta7
17+
```terminal
18+
We found conflicting component dependencies.
19+
You are trying to update package(s) magento/module-sample-data to 1.0.0-beta
20+
We've detected conflicts with the following packages:
21+
- magento/sample-data version 0.74.0-beta15. Please try to update it to one of the following package versions: 0.74.0-beta16, 0.74.0-beta14, 0.74.0-beta13, 0.74.0-beta12, 0.74.0-beta11, 0.74.0-beta10, 0.74.0-beta9, 0.74.0-beta8, 0.74.0-beta7
22+
```
2223

2324
{:.bs-callout .bs-callout-info}
2425
The message you see will likely be different.
@@ -33,13 +34,15 @@ Edit `composer.json` to make any of these changes and try the readiness check ag
3334

3435
If the Magento file system owner doesn't have permissions to write to directories on the Magento file system, a message similar to the following displays:
3536

36-
file_put_contents(/var/www/html/magento2ce/var/composer_home/cache/repo/https---
37-
packagist.org/provider-doctrine$instantiator.json): failed to open stream: Permission denied
37+
```terminal
38+
file_put_contents(/var/www/html/magento2ce/var/composer_home/cache/repo/https---
39+
packagist.org/provider-doctrine$instantiator.json): failed to open stream: Permission denied
40+
```
3841

3942
Make sure you set file system permissions as discussed in [Overview of ownership and permissions]({{ page.baseurl }}/install-gde/prereq/file-sys-perms-over.html).
4043

4144
### The Component Dependency Check status never changes {#trouble-depend-state}
4245

43-
In some cases, the status of the Component Dependency Check doesn't change, even after you try to correct issues. In that case, you can either delete or rename files named `<your Magento install dir>/var/.update_cronjob_status` and `<your Magento install dir>/var/.setup_cronjob_status` and try running the Component Manager again.
46+
In some cases, the status of the Component Dependency Check doesn't change, even after you try to correct issues. In that case, you can either delete or rename files named `<magento_root>/var/.update_cronjob_status` and `<magento_root>/var/.setup_cronjob_status` and try running the Component Manager again.
4447

4548
Renaming or removing these files forces the Component Manager to run the checks again.

_includes/config/locate-session.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,28 @@
22

33
This topic discusses how to locate where your session files are stored. The Magento application uses the following logic to store session files:
44

5-
* If you configured memcached, sessions are stored in RAM; for more information, see [Use memcached for session storage]({{ page.baseurl }}/config-guide/memcache/memcache.html).
6-
* If you configured Redis, sessions are stored on the Redis server; for more information, see [Use Redis for page caching or session storage]({{ page.baseurl }}/config-guide/redis/config-redis.html).
7-
* If you're using the default file-based session storage, we store sessions in the following locations in the order shown:
5+
* If you configured memcached, sessions are stored in RAM; for more information, see [Use memcached for session storage]({{ page.baseurl }}/config-guide/memcache/memcache.html).
6+
* If you configured Redis, sessions are stored on the Redis server; for more information, see [Use Redis for page caching or session storage]({{ page.baseurl }}/config-guide/redis/config-redis.html).
7+
* If you're using the default file-based session storage, we store sessions in the following locations in the order shown:
88

9-
1. Directory defined in [`env.php`](#session-where-env)
10-
2. Directory defined in [`php.ini`](#session-where-phpini)
11-
3. `<your Magento install dir>/var/session` directory
9+
1. Directory defined in [`env.php`](#session-where-env)
10+
1. Directory defined in [`php.ini`](#session-where-phpini)
11+
1. `<magento_root>/var/session` directory
1212

1313
### `env.php` example {#session-where-env}
14-
A sample snippet from `<your Magento install dir>/app/etc/env.php` follows:
1514

16-
'session' =>
17-
array (
18-
'save' => 'files',
19-
'save_path' => '/var/www/session',
20-
),
15+
A sample snippet from `<magento_root>/app/etc/env.php` follows:
16+
17+
```php
18+
'session' =>
19+
array (
20+
'save' => 'files',
21+
'save_path' => '/var/www/session',
22+
),
23+
```
2124

2225
The preceding example stores session files in `/var/www/session`
2326

2427
### `php.ini` example {#session-where-phpini}
28+
2529
As a user with `root` privileges, open your `php.ini` file and search for the value of `session.save_path`. This identifies where sessions are stored.
Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,50 @@
11
To set permissions before you install the Magento software:
22

3-
1. Log in to your Magento server.
4-
2. Use a file manager application provided by your shared hosting provider to verify write permissions are set on the following directories:
3+
1. Log in to your Magento server.
4+
1. Use a file manager application provided by your shared hosting provider to verify write permissions are set on the following directories:
55

6-
* `vendor` (Composer or compressed archive installation)
7-
* `app/etc`
8-
* `pub/static`
9-
* `var`
10-
* Any other static resources
6+
* `vendor` (Composer or compressed archive installation)
7+
* `app/etc`
8+
* `pub/static`
9+
* `var`
10+
* Any other static resources
1111

12-
2. If you have command-line access, enter the following commands in the order shown:
12+
1. If you have command-line access, enter the following commands in the order shown:
1313

14-
cd <your Magento install dir>
15-
find var vendor pub/static pub/media app/etc -type f -exec chmod u+w {} +
16-
find var vendor pub/static pub/media app/etc -type d -exec chmod u+w {} +
17-
chmod u+x bin/magento
14+
```bash
15+
cd <magento_root>
16+
```
1817

19-
To optionally enter all commands on one line, enter the following assuming Magento is installed in `/var/www/html/magento2`:
18+
```bash
19+
find var vendor pub/static pub/media app/etc -type f -exec chmod u+w {} +
20+
```
2021

21-
cd /var/www/html/magento2 && find var vendor pub/static pub/media app/etc -type f -exec chmod u+w {} + && find var vendor pub/static pub/media app/etc -type d -exec chmod u+w {} + && chmod u+x bin/magento
22-
3. If you haven't done so already, get the Magento software in one of the following ways:
22+
```bash
23+
find var vendor pub/static pub/media app/etc -type d -exec chmod u+w {} +
24+
```
2325

24-
* [Compressed archive]({{ page.baseurl }}/install-gde/prereq/zip_install.html)
25-
* [Composer metapackage]({{ page.baseurl }}/install-gde/composer.html)
26-
* [Clone the repository (contributing developers only)]({{ page.baseurl }}/install-gde/prereq/dev_install.html)
27-
4. After you have set file system ownership and permissions, continue with any of the following:
26+
```bash
27+
chmod u+x bin/magento
28+
```
2829

29-
* [Command-line installation]({{ page.baseurl }}/install-gde/install/cli/install-cli.html)
30-
* [Setup Wizard installation]({{ page.baseurl }}/install-gde/install/web/install-web.html)
30+
1. To optionally enter all commands on one line, enter the following, assuming Magento is installed in `/var/www/html/magento2`:
31+
32+
```bash
33+
cd /var/www/html/magento2 && find var vendor pub/static pub/media app/etc -type f -exec chmod u+w {} + && find var vendor pub/static pub/media app/etc -type d -exec chmod u+w {} + && chmod u+x bin/magento
34+
```
35+
36+
If you haven't done so already, get the Magento software in one of the following ways:
37+
38+
* [Compressed archive]({{ page.baseurl }}/install-gde/prereq/zip_install.html)
39+
* [Composer metapackage]({{ page.baseurl }}/install-gde/composer.html)
40+
* [Clone the repository (contributing developers only)]({{ page.baseurl }}/install-gde/prereq/dev_install.html)
41+
42+
1. After you have set file system ownership and permissions, continue with any of the following:
43+
44+
* [Command-line installation]({{ page.baseurl }}/install-gde/install/cli/install-cli.html)
45+
* [Setup Wizard installation]({{ page.baseurl }}/install-gde/install/web/install-web.html)
3146
3247
{:.bs-callout .bs-callout-info}
3348
To further restrict permissions after installing the Magento software, you [configure a Magento umask]({{ page.baseurl }}/install-gde/install/post-install-umask.html).
3449
35-
3650
*[contributing developer]: A developer who contributes code to the Magento 2 CE codebase
Lines changed: 37 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,51 @@
11
To set permissions before you install the Magento software:
22

3-
1. Log in to your Magento server.
4-
2. Use a file manager application provided by your shared hosting provider to verify write permissions are set on the following directories:
3+
1. Log in to your Magento server.
4+
1. Use a file manager application provided by your shared hosting provider to verify write permissions are set on the following directories:
55

6-
* `vendor` (Composer or compressed archive installation)
7-
* `app/etc`
8-
* `pub/static`
9-
* `var`
10-
* `generated`
11-
* Any other static resources
6+
* `vendor` (Composer or compressed archive installation)
7+
* `app/etc`
8+
* `pub/static`
9+
* `var`
10+
* `generated`
11+
* Any other static resources
1212

13-
2. If you have command-line access, enter the following commands in the order shown:
13+
1. If you have command-line access, enter the following commands in the order shown:
1414

15-
cd <your Magento install dir>
16-
find var generated vendor pub/static pub/media app/etc -type f -exec chmod u+w {} +
17-
find var generated vendor pub/static pub/media app/etc -type d -exec chmod u+w {} +
18-
chmod u+x bin/magento
15+
```bash
16+
cd <magento_root>
17+
```
1918

20-
To optionally enter all commands on one line, enter the following assuming Magento is installed in `/var/www/html/magento2`:
19+
```bash
20+
find var generated vendor pub/static pub/media app/etc -type f -exec chmod u+w {} +
21+
```
2122

22-
cd /var/www/html/magento2 && find var generated vendor pub/static pub/media app/etc -type f -exec chmod u+w {} + && find var generated vendor pub/static pub/media app/etc -type d -exec chmod u+w {} + && chmod u+x bin/magento
23-
3. If you haven't done so already, get the Magento software in one of the following ways:
23+
```bash
24+
find var generated vendor pub/static pub/media app/etc -type d -exec chmod u+w {} +
25+
```
2426

25-
* [Compressed archive]({{ page.baseurl }}/install-gde/prereq/zip_install.html)
26-
* [Composer metapackage]({{ page.baseurl }}/install-gde/composer.html)
27-
* [Clone the repository (contributing developers only)]({{ page.baseurl }}/install-gde/prereq/dev_install.html)
28-
4. After you have set file system ownership and permissions, continue with any of the following:
27+
```bash
28+
chmod u+x bin/magento
29+
```
2930

30-
* [Command-line installation]({{ page.baseurl }}/install-gde/install/cli/install-cli.html)
31-
* [Setup Wizard installation]({{ page.baseurl }}/install-gde/install/web/install-web.html)
31+
To optionally enter all commands on one line, enter the following assuming Magento is installed in `/var/www/html/magento2`:
32+
33+
```bash
34+
cd /var/www/html/magento2 && find var generated vendor pub/static pub/media app/etc -type f -exec chmod u+w {} + && find var generated vendor pub/static pub/media app/etc -type d -exec chmod u+w {} + && chmod u+x bin/magento
35+
```
36+
37+
1. If you haven't done so already, get the Magento software in one of the following ways:
38+
39+
* [Compressed archive]({{ page.baseurl }}/install-gde/prereq/zip_install.html)
40+
* [Composer metapackage]({{ page.baseurl }}/install-gde/composer.html)
41+
* [Clone the repository (contributing developers only)]({{ page.baseurl }}/install-gde/prereq/dev_install.html)
42+
43+
1. After you have set file system ownership and permissions, continue with any of the following:
44+
45+
* [Command-line installation]({{ page.baseurl }}/install-gde/install/cli/install-cli.html)
46+
* [Setup Wizard installation]({{ page.baseurl }}/install-gde/install/web/install-web.html)
3247
3348
{:.bs-callout .bs-callout-info}
3449
To further restrict permissions after installing the Magento software, you [configure a Magento umask]({{ page.baseurl }}/install-gde/install/post-install-umask.html).
3550
36-
3751
*[contributing developer]: A developer who contributes code to the Magento 2 CE codebase

0 commit comments

Comments
 (0)