Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Explain shell_exec requirement #14782

Closed
Findus23 opened this issue Aug 18, 2019 · 4 comments · Fixed by #18469
Closed

[Docs] Explain shell_exec requirement #14782

Findus23 opened this issue Aug 18, 2019 · 4 comments · Fixed by #18469
Assignees
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: Website matomo.org For issues related to our matomo.org website.
Milestone

Comments

@Findus23
Copy link
Member

I am a bit confused by the usage of shell_exec in Matomo and can't find any docs for it.

  • https://matomo.org/docs/requirements/ doesn't mention that it is required
  • In the few places I checked there is often a if (!function_exists('shell_exec')) { indicating that is only recommended, but not required
  • There are no docs explaining what Matomo needs shell_exec for (or even what it is and how to enable it)
  • The system check is called RecommendedFunctionsCheck indicating that it isn't required
  • but the warning it gives is You need to enable this built-in function. and Sie müssen diese eingebaute Funktion aktivieren indicating that it is required.

Can someone who knows the background help clarifying all docs?

@Findus23 Findus23 added the c: Website matomo.org For issues related to our matomo.org website. label Aug 18, 2019
@mattab mattab added the c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. label Jan 21, 2020
@mattab mattab added this to the 4.2.0 milestone Jan 21, 2020
@ghost
Copy link

ghost commented Sep 5, 2020

@mattab I see that addressing this topic is planned for the 4.x series of releases, but in the meantime, do you mind answering the question of whether or not enabling shell_exec is mandatory for using the 3.x series of Matomo releases?

@tsteur
Copy link
Member

tsteur commented Sep 6, 2020

I had a very quick look and doesn't seem to be required, only optional.

@mattab
Copy link
Member

mattab commented May 26, 2021

btw It is optional but (only?) required for the "CLI processes" to work during core:archive, which is important for higher traffic websites, or for Matomo instances that have a lot of segments, or that have a lot of websites. learn more: https://matomo.org/faq/troubleshooting/how-to-make-the-diagnostic-managing-processes-via-cli-to-display-ok/

@tsteur
Copy link
Member

tsteur commented Oct 7, 2021

As part of this issue we change You need to enable this built-in function. to We recommend you enable this built-in function.. We could also link to https://matomo.org/faq/troubleshooting/how-to-make-the-diagnostic-managing-processes-via-cli-to-display-ok/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. c: Website matomo.org For issues related to our matomo.org website.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants