Matrix/element-desktop
Matrix/element-desktop
1
0
Fork 0
mirror of https://github.com/vector-im/element-desktop.git synced 2024-07-02 04:23:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
element-desktop/README.md

157 lines
6 KiB
Markdown
Raw Permalink Normal View History

Add README badges (#357)
2022-05-04 20:33:33 +00:00
![Build](https://github.com/vector-im/element-desktop/actions/workflows/build.yaml/badge.svg)
![Static Analysis](https://github.com/vector-im/element-desktop/actions/workflows/static_analysis.yaml/badge.svg)
Migrate translations to keys and switch to Localazy (#1198)
2023-09-05 16:09:47 +00:00
[![Localazy](https://img.shields.io/endpoint?url=https%3A%2F%2Fconnect.localazy.com%2Fstatus%2Felement-web%2Fdata%3Fcontent%3Dall%26title%3Dlocalazy%26logo%3Dtrue)](https://localazy.com/p/element-web)
Add README badges (#357)
2022-05-04 20:33:33 +00:00
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=element-desktop&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=element-desktop)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=element-desktop&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=element-desktop)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=element-desktop&metric=bugs)](https://sonarcloud.io/summary/new_code?id=element-desktop)
Format all files with prettier
2022-12-15 11:00:58 +00:00
# Element Desktop
Files I've added This still won't work, still a WIP
2019-12-06 18:20:31 +00:00
Apply suggestion to README.md
2020-07-01 16:42:24 +00:00
Element Desktop is a Matrix client for desktop platforms with Element Web at its core.
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
Format all files with prettier
2022-12-15 11:00:58 +00:00
# First Steps
Don't forget to yarn install
2020-07-15 11:53:50 +00:00
Before you do anything else, fetch the dependencies:
```
yarn install
```
Format all files with prettier
2022-12-15 11:00:58 +00:00
# Fetching Element
Apply suggestion to README.md
2020-07-01 16:42:39 +00:00
Since this package is just the Electron wrapper for Element Web, it doesn't contain any of the Element Web code,
Apply suggestion to README.md
2020-07-01 16:42:50 +00:00
so the first step is to get a working copy of Element Web. There are a few ways of doing this:
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
Replace Riot with Element in docs and comments This only covers the simple cases of references to issues and repos. More complex areas, such as deployment scripts, will be handled separately. Part of https://github.com/vector-im/element-web/issues/14864
2020-08-03 15:05:04 +00:00
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version
Rebrand step 1: s/riot/element/ in the places where it's reasonably simple
2020-07-01 14:30:53 +00:00
# fetched will be the same as the local element-desktop package.
# We're explicitly asking for no config, so the packaged Element will have no config.json.
Use double quotes in readme which work in the windows shell
2021-07-07 14:48:58 +00:00
yarn run fetch --noverify --cfgdir ""
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
...or if you'd like to use GPG to verify the downloaded package:
Format all files with prettier
2022-12-15 11:00:58 +00:00
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
change domain for fetching key
2020-07-01 16:44:40 +00:00
# Fetch the Element public key from the element.io web server over a secure connection and import
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
# it into your local GPG keychain (you'll need GPG installed). You only need to to do this
# once.
yarn run fetch --importkey
# Fetch the package and verify the signature
Use double quotes in readme which work in the windows shell
2021-07-07 14:48:58 +00:00
yarn run fetch --cfgdir ""
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
Rebrand step 1: s/riot/element/ in the places where it's reasonably simple
2020-07-01 14:30:53 +00:00
...or either of the above, but fetching a specific version of Element:
Format all files with prettier
2022-12-15 11:00:58 +00:00
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
Replace Riot with Element in docs and comments This only covers the simple cases of references to issues and repos. More complex areas, such as deployment scripts, will be handled separately. Part of https://github.com/vector-im/element-web/issues/14864
2020-08-03 15:05:04 +00:00
# Fetch the prebuilt release Element package from the element-web GitHub releases page. The version
Rebrand step 1: s/riot/element/ in the places where it's reasonably simple
2020-07-01 14:30:53 +00:00
# fetched will be the same as the local element-desktop package.
Use double quotes in readme which work in the windows shell
2021-07-07 14:48:58 +00:00
yarn run fetch --noverify --cfgdir "" v1.5.6
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
If you only want to run the app locally and don't need to build packages, you can
provide the `webapp` directory directly:
Format all files with prettier
2022-12-15 11:00:58 +00:00
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
Replace Riot with Element in docs and comments This only covers the simple cases of references to issues and repos. More complex areas, such as deployment scripts, will be handled separately. Part of https://github.com/vector-im/element-web/issues/14864
2020-08-03 15:05:04 +00:00
# Assuming you've checked out and built a copy of element-web in ../element-web
ln -s ../element-web/webapp ./
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
[TODO: add support for fetching develop builds, arbitrary URLs and arbitrary paths]
Format all files with prettier
2022-12-15 11:00:58 +00:00
# Building
Support universal builds Hopefully adequately documented in the README
2021-07-06 22:52:19 +00:00
Refactor the build docs into something easier to follow (#324) * Refactor the build docs into something easier to follow * fix typo
2022-02-16 11:25:14 +00:00
## Native Build
Support universal builds Hopefully adequately documented in the README
2021-07-06 22:52:19 +00:00
Refactor the build docs into something easier to follow (#324) * Refactor the build docs into something easier to follow * fix typo
2022-02-16 11:25:14 +00:00
TODO: List native pre-requisites
Fix order of README steps to be in the order they needd to be run.
2020-07-31 20:04:54 +00:00
Format all files with prettier
2022-12-15 11:00:58 +00:00
Optionally, [build the native modules](https://github.com/vector-im/element-desktop/blob/develop/docs/native-node-modules.md),
which include support for searching in encrypted rooms and secure storage. Skipping this step is fine, you just won't have those features.
Fix order of README steps to be in the order they needd to be run.
2020-07-31 20:04:54 +00:00
Refactor the build docs into something easier to follow (#324) * Refactor the build docs into something easier to follow * fix typo
2022-02-16 11:25:14 +00:00
Then, run
Format all files with prettier
2022-12-15 11:00:58 +00:00
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
yarn run build
```
Format all files with prettier
2022-12-15 11:00:58 +00:00
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
This will do a couple of things:
Format all files with prettier
2022-12-15 11:00:58 +00:00
- Run the `setversion` script to set the local package version to match whatever
version of Element you installed above.
- Run electron-builder to build a package. The package built will match the operating system
you're running the build process on.
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
Refactor the build docs into something easier to follow (#324) * Refactor the build docs into something easier to follow * fix typo
2022-02-16 11:25:14 +00:00
## Docker
Split 32/64 bit building As they'll need different native deps
2020-02-19 14:21:33 +00:00
Refactor the build docs into something easier to follow (#324) * Refactor the build docs into something easier to follow * fix typo
2022-02-16 11:25:14 +00:00
Alternatively, you can also build using docker, which will always produce the linux package:
Format all files with prettier
2022-12-15 11:00:58 +00:00
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
Docker powered linux building
2020-02-17 20:10:58 +00:00
# Run this once to make the docker image
yarn run docker:setup
Fix readme
2019-12-13 12:18:32 +00:00
yarn run docker:install
More doc
2020-02-17 20:25:10 +00:00
# if you want to build the native modules (this will take a while)
Fix docker:build:native documentation typo
2021-03-25 15:40:47 +00:00
yarn run docker:build:native
Fix readme
2019-12-13 12:18:32 +00:00
yarn run docker:build
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
After running, the packages should be in `dist/`.
Format all files with prettier
2022-12-15 11:00:58 +00:00
# Starting
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
If you'd just like to run the electron app locally for development:
Format all files with prettier
2022-12-15 11:00:58 +00:00
Set version automatically Convert the check script to a script that sets the version to match whatever Riot is being packaged. Add a README because the two ways of interacting with versions are starting to get complex to reason about. Also add a docker build script.
2019-12-12 19:33:29 +00:00
```
# Install electron - we don't normally need electron itself as it's provided
# by electron-builder when building packages
yarn add electron
yarn start
```
Support config directories
2019-12-13 11:13:44 +00:00
Format all files with prettier
2022-12-15 11:00:58 +00:00
# Config
Rebrand step 1: s/riot/element/ in the places where it's reasonably simple
2020-07-01 14:30:53 +00:00
If you'd like the packaged Element to have a configuration file, you can create a
Support config directories
2019-12-13 11:13:44 +00:00
config directory and place `config.json` in there, then specify this directory
with the `--cfgdir` option to `yarn run fetch`, eg:
Format all files with prettier
2022-12-15 11:00:58 +00:00
Support config directories
2019-12-13 11:13:44 +00:00
```
mkdir myconfig
cp /path/to/my/config.json myconfig/
yarn run fetch --cfgdir myconfig
```
Format all files with prettier
2022-12-15 11:00:58 +00:00
Replace Riot with Element in docs and comments This only covers the simple cases of references to issues and repos. More complex areas, such as deployment scripts, will be handled separately. Part of https://github.com/vector-im/element-web/issues/14864
2020-08-03 15:05:04 +00:00
The config dir for the official Element app is in `element.io`. If you use this,
Rebrand step 1: s/riot/element/ in the places where it's reasonably simple
2020-07-01 14:30:53 +00:00
your app will auto-update itself using builds from element.io.
Update README Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-06 10:19:08 +00:00
Format all files with prettier
2022-12-15 11:00:58 +00:00
# Profiles
Update README Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-06 10:19:08 +00:00
To run multiple instances of the desktop app for different accounts, you can
launch the executable with the `--profile` argument followed by a unique
Rebrand step 1: s/riot/element/ in the places where it's reasonably simple
2020-07-01 14:30:53 +00:00
identifier, e.g `element-desktop --profile Work` for it to run a separate profile and
Update README Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-06 10:19:08 +00:00
not interfere with the default one.
Alternatively, a custom location for the profile data can be specified using the
`--profile-dir` flag followed by the desired path.
Format all files with prettier
2022-12-15 11:00:58 +00:00
# User-specified config.json
Update README Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-06 10:19:08 +00:00
Format all files with prettier
2022-12-15 11:00:58 +00:00
- `%APPDATA%\$NAME\config.json` on Windows
- `$XDG_CONFIG_HOME/$NAME/config.json` or `~/.config/$NAME/config.json` on Linux
- `~/Library/Application Support/$NAME/config.json` on macOS
Update README Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-06 10:19:08 +00:00
Rebrand step 1: s/riot/element/ in the places where it's reasonably simple
2020-07-01 14:30:53 +00:00
In the paths above, `$NAME` is typically `Element`, unless you use `--profile
$PROFILE` in which case it becomes `Element-$PROFILE`, or it is using one of
the above created by a pre-1.7 install, in which case it will be `Riot` or
`Riot-$PROFILE`.
Update README.md
2020-07-15 16:25:02 +00:00
Format all files with prettier
2022-12-15 11:00:58 +00:00
# Translations
Add internationalisation documentation
2021-04-26 13:19:48 +00:00
To add a new translation, head to the [translating doc](https://github.com/vector-im/element-web/blob/develop/docs/translating.md).
For a developer guide, see the [translating dev doc](https://github.com/vector-im/element-web/blob/develop/docs/translating-dev.md).
Format all files with prettier
2022-12-15 11:00:58 +00:00
# Report bugs & give feedback
Update README.md
2020-07-15 16:25:02 +00:00
If you run into any bugs or have feedback you'd like to share, please let us know on GitHub.
Format all files with prettier
2022-12-15 11:00:58 +00:00
To help avoid duplicate issues, please [view existing issues](https://github.com/vector-im/element-web/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc) first (and add a +1) or [create a new issue](https://github.com/vector-im/element-web/issues/new/choose) if you can't find it. Please note that this issue tracker is associated with the [element-web](https://github.com/vector-im/element-web) repo, but is also applied to the code in this repo as well.
Reference in a new issue Copy permalink