session-android/README.md

84 lines
2.9 KiB
Markdown
Raw Normal View History

2020-02-13 14:32:43 +11:00
# Session Android
2011-12-20 10:20:44 -08:00
2020-02-17 16:57:03 +11:00
[Download on the Google Play Store](https://getsession.org/android)
2013-12-16 09:58:56 -08:00
Add the [F-Droid repo](https://fdroid.getsession.org/)
2021-05-28 18:46:54 +07:00
[Download the APK from here](https://github.com/loki-project/session-android/releases/latest)
2013-12-16 09:58:56 -08:00
2020-02-13 14:32:43 +11:00
## Summary
2011-12-20 10:20:44 -08:00
Session integrates directly with [Oxen Service Nodes](https://docs.oxen.io/about-the-oxen-blockchain/oxen-service-nodes), which are a set of distributed, decentralized and Sybil resistant nodes. Service Nodes act as servers which store messages offline, and a set of nodes which allow for onion routing functionality obfuscating users' IP addresses. For a full understanding of how Session works, read the [Session Whitepaper](https://getsession.org/whitepaper).
2011-12-20 10:20:44 -08:00
2021-05-24 13:15:24 +10:00
<img src="https://i.imgur.com/RSMrR1F.png" width="320" />
2011-12-20 10:20:44 -08:00
2020-06-03 10:33:38 +10:00
## Want to contribute? Found a bug or have a feature request?
2011-12-20 10:20:44 -08:00
Please search for any [existing issues](https://github.com/oxen-io/session-android/issues) that describe your bugs in order to avoid duplicate submissions. Submissions can be made by making a pull request to our `dev` branch. If you don't know where to start contributing, try reading the Github issues page for ideas.
2020-06-03 10:33:38 +10:00
## Build instructions
2020-02-13 14:32:43 +11:00
Build instructions can be found in [BUILDING.md](BUILDING.md).
2011-12-20 10:20:44 -08:00
2021-05-24 13:06:08 +10:00
## Translations
Want to help us translate Session into your language? You can do so at https://crowdin.com/project/session-android!
2021-05-24 13:04:43 +10:00
## Verifying signatures
2021-05-24 10:11:01 +10:00
2021-05-24 13:04:43 +10:00
**Step 1:**
2021-05-24 10:11:01 +10:00
```
wget https://raw.githubusercontent.com/oxen-io/oxen-core/master/utils/gpg_keys/KeeJef.asc
gpg --import KeeJef.asc
```
2021-05-24 13:04:43 +10:00
**Step 2:**
Get the signed hash for this release. `SESSION_VERSION` needs to be updated for the release you want to verify.
2021-05-24 10:11:01 +10:00
```
export SESSION_VERSION=1.10.4
wget https://github.com/oxen-io/session-android/releases/download/$SESSION_VERSION/signatures.asc
```
2021-05-24 13:04:43 +10:00
**Step 3:**
Verify the signature of the hashes of the files.
2021-05-24 10:11:01 +10:00
```
gpg --verify signatures.asc 2>&1 |grep "Good signature from"
```
2021-05-24 13:06:08 +10:00
The command above should print "`Good signature from "Kee Jefferys...`". If it does, the hashes are valid but we still have to make the sure the signed hashes matches the downloaded files.
2021-05-24 10:11:01 +10:00
2021-05-24 13:04:43 +10:00
**Step 4:**
2021-05-24 13:06:08 +10:00
Make sure the two commands below returns the same hash. If they do, files are valid.
2021-05-24 10:11:01 +10:00
```
sha256sum session-$SESSION_VERSION-universal.apk
grep universal.apk signatures.asc
```
2014-04-25 15:52:03 -07:00
## License
2011-12-20 10:20:44 -08:00
Copyright 2011 Whisper Systems
2014-04-25 15:52:03 -07:00
Copyright 2013-2017 Open Whisper Systems
2011-12-20 10:20:44 -08:00
2021-05-24 13:04:43 +10:00
Copyright 2019-2021 The Loki Project
2020-02-13 14:32:43 +11:00
Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html
2021-08-04 13:16:07 +07:00
## Social
<a href="https://www.facebook.com/SessionMessenger/">
<img align="left" width="24px" src="https://www.vectorlogo.zone/logos/facebook/facebook-icon.svg" />
</a>
<a href="https://twitter.com/session_app">
<img align="left" width="26px" src="https://www.vectorlogo.zone/logos/twitter/twitter-official.svg" />
</a>
<a href="mailto:support@getsession.org">
<img align="left" width="26px" src="https://www.vectorlogo.zone/logos/gmail/gmail-icon.svg" />
</a>