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

Jump to bottom

Update FAQ "How do I use Piwik from the official Git repository?" #7842

Closed
tsteur opened this issue May 5, 2015 · 7 comments
Closed

Update FAQ "How do I use Piwik from the official Git repository?" #7842

tsteur opened this issue May 5, 2015 · 7 comments
Labels
c: Website matomo.org For issues related to our matomo.org website. not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Milestone
2.14.0

Comments

@tsteur
Copy link
Member

tsteur commented May 5, 2015

http://piwik.org/faq/how-to-install/faq_18271/

There is already a note that we do not recommend to use latest master on production server. This note is at the very end. We should really put this note above the bash example how to do it.

Even more importantly we should explain why it is not good to use an installation from git in Production/QA/Testing/ ... or on any server that can be accessed by anyone via the Internet/Intranet. Piwik via git should be only used for development. This warning must be at the very beginning. Some reasons:

  • It is a security risk: For example in our piwik.zip we remove many files that are not needed in production and could potentially even cause harm. For example all of our test files etc.
  • Some default settings are changed which cause Piwik to be slower than using latest.zip (this will happen in near future but we should still warn re this) refs Enable development mode by default and disable it in latest.zip #6536

Users are not aware that it is not good to use Piwik via git see for example #7838 (comment)

Recommendation for users who still want to install Piwik via git:

A user should instead consider to commit the content of latest.zip into a repository, tag a new version, and checkout this version on your server that only contains the files that are supposed to be in production.

If we don't update this FAQ, I would almost insist that we create a repository (or a branch) for the content of latest.zip ourselves, that we maintain it and put the URL of that repository into the FAQ.
@tsteur tsteur added Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change. c: Website matomo.org For issues related to our matomo.org website. labels May 5, 2015
@tsteur tsteur added this to the Piwik 2.14.0 milestone May 5, 2015
@mnapoli
Copy link
Contributor

mnapoli commented May 6, 2015

👍 we should say it's not supported at all. Sometimes it impacts us in our work (we have to think of this use case) but we shouldn't have to care about it (I remember a few times where we had to test/do a few things to preserve this use case).

@tsteur
Copy link
Member Author

tsteur commented May 6, 2015

we should say it's not supported at all.

We should say it's not supported and we still should explain why and how they can do it better as there otherwise always will be users who just do it though.

@mnapoli
Copy link
Contributor

mnapoli commented May 6, 2015

👍

@mnapoli mnapoli mentioned this issue May 21, 2015
Closed
@AndersBillLinden
Copy link
Contributor

There should also be a note that the full path to composer.phar must be given in the command php composer.phar install and what composer actually is maybe?

@tsteur
Copy link
Member Author

tsteur commented Jun 9, 2015

I'd recommend something like the following:

To use Piwik the recommended way is to download the latest stable version. It is not recommended to use Piwik directly from our Git repository for various reasons:

  • The Piwik version from Git contains files that are only needed for development. Those files are not needed in production and could potentially cause harm, for example our test files.
  • Some default settings are different which can cause Piwik to be slower. For example caches might be disabled by default.

In case you want to use the very latest bleeding edge Piwik nonetheless and understand the risk, you may use Piwik directly from our Git repository. To deploy Piwik from Git, run the following commands once:

THE EXAMPLE HOW TO INSTALL APPENDED BY

./console development:disable

@tsteur
Copy link
Member Author

tsteur commented Jun 9, 2015

@mattab this is something you probably would need to update? I mean the FAQ

@mattab
Copy link
Member

mattab commented Jun 9, 2015

FAQ was updated: How do I use Piwik from the official Git repository?
Thanks Thomas

@mattab mattab closed this as completed Jun 9, 2015
@mattab mattab added the not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. label Jun 24, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c: Website matomo.org For issues related to our matomo.org website. not-in-changelog For issues or pull requests that should not be included in our release changelog on matomo.org. Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Projects
None yet
Milestone
2.14.0
Development

No branches or pull requests
4 participants
@tsteur @mattab @mnapoli @AndersBillLinden