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

Added pre-requisites for building native modules on linux and updated native-node-modules.md #344

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from

Conversation

ttheshreeyasingh
Copy link

@ttheshreeyasingh ttheshreeyasingh commented Apr 21, 2022

Added file linux-requirements.md in element-desktop/docs and updated native-node-modules.md, put the config part before the yarn start step for more clarity. Also added steps to install SQLCipher library in Adding Seshat for search in E2E encrypted rooms. Made all the changes requested on the previous PR.
PS: Created a new PR due to some merging issues faced
Signed-off-by: Shreeya shreeya.singh@students.iiit.ac.in


This PR currently has no changelog labels, so will not be included in changelogs.

A reviewer can add one of: T-Deprecation, T-Enhancement, T-Defect, T-Task to indicate what type of change this is, or add Type: [enhancement/defect/task] to the description and I'll add them for you.

@ttheshreeyasingh ttheshreeyasingh requested a review from a team as a code owner April 21, 2022 16:32
@ArchangeGabriel
Copy link

(You could have force pushed to your branch after cleaning locally)

You did not address my comment.

@ttheshreeyasingh
Copy link
Author

@andybalaam Hi, could you re-review this PR?

(You could have force pushed to your branch after cleaning locally)

You did not address my comment.

Sorry, was facing some issues, my bad.
regarding your comment, should I not mention the installation of SQLCipher at all?
image
and change this as well?

@ArchangeGabriel
Copy link

Sorry, was facing some issues, my bad. regarding your comment, should I not mention the installation of SQLCipher at all? image and change this as well?

Yeah, you could instead write “Seshat also depends on the SQLCipher library to store its data in encrypted from on disk. This dependency is however vendored and compiled statically to avoid conflicts with any other sqlite library that might be loaded.”.

@ttheshreeyasingh
Copy link
Author

Yeah, you could instead write “Seshat also depends on the SQLCipher library to store its data in encrypted from on disk. This dependency is however vendored and compiled statically to avoid conflicts with any other sqlite library that might be loaded.”.

Since it's the dependency is taken care of and the user doesn't need to run any command, I've removed the sentence as it felt unnecessary. Does that work?

@ArchangeGabriel
Copy link

Fine by me, but I’m not in anyway a decision maker here. ;)

@dbkr
Copy link
Member

dbkr commented Apr 22, 2022

Unfortunately the story with SQLCipher here is a bit more complex. The doc says to add matrix seshat directly with yarn, which I think is a bit odd (I filed element-hq/element-web#21883 for that) but this means it won't build its own SQLCipher, static or otherwise, like it does when running yarn run build:native, so you'll still need an SQLCipher separately. IMO the best thing to do would be for the doc to just direct the user to yarn run build:native though.

In general, I'd prefer that we didn't copy & paste installation instructions for everything into our doc, as it's more for us to keep up to date: I'd suggest just referring to the project homepage and telling the user to install things however they prefer. On Node, I wouldn't bother with this in this doc at all since it's necessary for building the app at all, not just the native modules.

Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

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

@dbkr's comment needs addressing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants