8000 Update the Linux install steps and package listing by mike-myers-tob · Pull Request #6956 · osquery/osquery · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
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.

Sign up for GitHub

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 the Linux install steps and package listing #6956

Merged
merged 3 commits into from
Feb 23, 2021
Merged

Update the Linux install steps and package listing #6956

merged 3 commits into from
Feb 23, 2021

Conversation

mike-myers-tob
Copy link
Member

The install paths for Linux have changed since the last time the docs were accurate, so I've tried to remedy that.

@mike-myers-tob mike-myers-tob requested a review from a team as a code owner February 19, 2021 23:26
@mike-myers-tob mike-myers-tob added the ready for review Pull requests that are ready to be reviewed by a maintainer label Feb 19, 2021
@mike-myers-tob mike-myers-tob changed the title Update the Linux install steps and package description Update the Linux install steps and package listing Feb 19, 2021
@mike-myers-tob
Copy link
Member Author

Sanity check me here, because it seems like the service startup scripts also do not know to find osqueryd in /usr/local/bin despite the fact that CPack built the TGZ package this way. Was it the package that was incorrect, not the docs and the scripts?

@Smjert
Copy link
Member
Smjert commented Feb 20, 2021

Sanity check me here, because it seems like the service startup scripts also do not know to find osqueryd in /usr/local/bin despite the fact that CPack built the TGZ package this way. Was it the package that was incorrect, not the docs and the scripts?

The TGZ uses the prefix directly from CMAKE_INSTALL_PREFIX which by default is /usr/local; the RPM and DEB packages though change that prefix to be /usr.

directionless
directionless previously approved these changes Feb 22, 2021
View reviewed changes
Copy link
Member
@directionless directionless left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect the docs could use a much deeper overhaul. but this looks like a small improvement

@mike-myers-tob
Copy link
Member Author

I suspect the docs could use a much deeper overhaul. but this looks like a small improvement

Many small improvements over time add up, is my hope.

But back to @Smjert 's comment: which is the "correct" or standard place to install osquery on Linux? I'd like to change the docs here to mention the install path prefix CMake thing, and then make a note that it's configurable.

@Smjert
Copy link
Member
Smjert commented Feb 22, 2021 •
edited
Loading

I suspect the docs could use a much deeper overhaul. but this looks like a small improvement

Many small improvements over time add up, is my hope.

But back to @Smjert 's comment: which is the "correct" or standard place to install osquery on Linux? I'd like to change the docs here to mention the install path prefix CMake thing, and then make a note that it's configurable.

The default we have for packages is /usr (and it's the default that the packaging system set itself) because packages are normally expected to install under that.
/usr/local is for things installed out of the packaging system, like via scripts or via make install after compilation, which is why the default is in fact /usr/local for CMake too.
Keep in mind that CMAKE_INSTALL_PREFIX is only used at install time when either you manually call the install target or CPack calls the install target to prepare the package.
CPACK_PACKAGING_INSTALL_PREFIX is what chooses the prefix used by the package itself when installing.

@directionless
Copy link
Member

There's a reasonable argument that we should move to /opt but I think that's out of scope here.

@mike-myers-tob
Copy link
Member Author

Ok, I believe the changes I made are now accurate. Thanks for the clarification!

directionless
directionless previously approved these changes Feb 22, 2021
View reviewed changes
@mike-myers-tob @Smjert
Update docs/wiki/development/building.md
e349964 
Co-authored-by: Stefano Bonicatti <stefano.bonicatti@gmail.com>
@directionless directionless merged commit d80bb56 into osquery:master Feb 23, 2021
@mike-myers-tob mike-myers-tob deleted the mike/docs-fix-linux-install-steps branch March 5, 2021 00:23
@mike-myers-tob mike-myers-tob removed the ready for review Pull requests that are ready to be reviewed by a maintainer label Dec 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Smjert Smjert Smjert left review comments

@theopolis theopolis theopolis approved these changes

@directionless directionless directionless left review comments

Assignees
No one assigned
Labels
documentation Linux
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mike-myers-tob @Smjert @directionless @theopolis
0