Threema Web is a web client for Threema, a privacy-focussed end-to-end encrypted mobile messenger hosted and developed in Switzerland. With Threema Web, you can use Threema on your Desktop without compromising security.
Threema Web establishes a connection between Desktop and mobile device using WebRTC (Android) or encrypted WebSockets (iOS). Signaling and data is end-to-end encrypted with SaltyRTC.
For more information, see the Threema Cryptography Whitepaper.
If you find a bug in Threema Web or want to request a new feature, feel free to open an issue on GitHub. Please make sure that your bug report or feature request hasn't already been filed by using the search function.
Express your personal opinion regarding priority by reacting with 👍 in a particular issue, such as this one. We will factor this in when scheduling what to do next.
We may occasionally deploy experimental branches on
https://web-beta.threema.ch which you are
encouraged to test. If you encounter problems, please
open an issue and
include the experiment's version number (e.g. 1.2.3-experiment-beta4).
If you want to help translating Threema Web to your language, please check out
TRANSLATING.md!
The protocol used to communicate between the Threema app and Threema Web is documented here.
Threema Web is written using TypeScript and AngularJS 1. Dependencies are managed with npm. You currently need Node.js 8 or later to build Threema Web. (Note that Node.js is only a build dependency, the result is plain old client-side JavaScript.)
Install development dependencies:
npm install
Run the dev server:
npm run devserver
Then open the URL in your browser:
firefox http://localhost:9966
(Note that this setup should not be used in production. To run Threema Web on a server, please follow the instructions at docs/self_hosting.md.)
To run unit tests:
npm run build:unittests && npm run testserver
firefox http://localhost:7777/tests/testsuite.html
To run UI tests:
npm run build # Required for CSS to be rebuilt
npm run test:ui <browser>
For example:
npm run test:ui firefox
npm run test:ui chrome
You can also filter the test cases:
npm run test:ui firefox emoji
To run linting checks:
npm run lint
You can also install a pre-push hook to do the linting:
echo -e '#!/bin/sh\nnpm run lint' > .git/hooks/pre-push
chmod +x .git/hooks/pre-push
The configuration of Threema Web can be tweaked in src/config.ts:
General
SELF_HOSTED: Set this totrueif this instance of Threema Web isn't being hosted onweb.threema.ch.PREV_PROTOCOL_LAST_VERSION: When the Threema Web protocol version changes, this can be set to the last version of Threema Web that supported the previous protocol version. If set to something different thannull, a message will be shown to the user if reconnecting fails.
SaltyRTC
SALTYRTC_HOST: Set this to the hostname of the SaltyRTC server that you want to use. If set tonull, the hostname will be constructed based on theSALTYRTC_HOST_PREFIXand theSALTYRTC_HOST_SUFFIXvalues.SALTYRTC_PORT: The port of the SaltyRTC server to be used.SALTYRTC_SERVER_KEY: The public permanent key of the SaltyRTC server. Set this value tonullif your server does not provide a public permanent key, or if you don't want to verify it.
ICE
ICE_SERVERS: Configuration object for the WebRTC STUN and ICE servers.
Push
PUSH_URL: The server URL used to deliver push notifications to the app.
For instructions on how to host your own version of Threema Web, please refer to docs/self_hosting.md.
Contributions to Threema Web are welcome! Please open a pull request with your proposed changes.
Every Threema Web release will be tagged. The git tags are cryptographically signed using the following PGP key:
pub rsa4096 2016-09-06 [SC] [expires: 2026-09-04]
E7AD D991 4E26 0E8B 35DF B506 65FD E935 573A CDA6
uid Threema Signing Key <[email protected]>
The public key can be found on Keybase.
If you discover a security issue in the Threema Web, please follow responsible disclosure and report it directly to Threema instead of opening an issue on Github. You can find the security e-mail as well as the PGP public key at https://threema.ch/en/contact.
Threema Web license:
Threema Web.
Copyright © 2016-2019 Threema GmbH (https://threema.ch/).
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
For third party library licenses, see LICENSE-3RD-PARTY.txt.