PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Update native-node-modules.md

Browse source
This commit is contained in:
Resynth 2020-07-17 11:28:10 +00:00 committed by resynth1943
parent 0f159c5d77
commit 5d8b246ef1
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/native-node-modules.md
View file

@ -1,24 +1,24 @@
# Native Node Modules # Native Node Modules
For some features, the desktop version of Riot can make use of native Node For some features, the desktop version of Element can make use of native Node
modules. These allow Riot to integrate with the desktop in ways that a browser modules. These allow Riot to integrate with the desktop in ways that a browser
cannot. cannot.
While native modules enable powerful new features, they must be complied for While native modules enable powerful new features, they must be complied for
each operating system. For official Riot releases, we will always build these each operating system. For official Element releases, we will always build these
modules from source to ensure we can trust the compiled output. In the future, modules from source to ensure we can trust the compiled output. In the future,
we may offer a pre-compiled path for those who want to use these features in a we may offer a pre-compiled path for those who want to use these features in a
custom build of Riot without installing the various build tools required. custom build of Element without installing the various build tools required.
Do note that compiling a module for a particular operating system Do note that compiling a module for a particular operating system
(Linux/macOS/Windows) will need to be done on that operating system. (Linux/macOS/Windows) will need to be done on that operating system.
Cross-compiling from a host OS for a different target OS may be possible, but Cross-compiling from a host OS for a different target OS may be possible, but
we don't support this flow with Riot dependencies at this time. we don't support this flow with Element dependencies at this time.
At the moment, we need to make some changes to the Riot release process before At the moment, we need to make some changes to the Element release process before
we can support native Node modules at release time, so these features are we can support native Node modules at release time, so these features are
currently disabled by default until that is resolved. The following sections currently disabled by default until that is resolved. The following sections
explain the manual steps you can use with a custom build of Riot to enable explain the manual steps you can use with a custom build of Element to enable
these features if you'd like to try them out. these features if you'd like to try them out.
## Adding Seshat for search in E2E encrypted rooms ## Adding Seshat for search in E2E encrypted rooms
@ -53,7 +53,7 @@ Please make sure to include all the `--` as well as the `--release` command line
switch at the end. Modify your electron version accordingly depending on the switch at the end. Modify your electron version accordingly depending on the
version that is installed on your system. version that is installed on your system.
After this is done the Electron version of Riot can be run from the main folder After this is done the Electron version of Element can be run from the main folder
as usual using: as usual using:
yarn electron yarn electron