|
|
|
<div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div># What is Jami?
|
|
|
|
|
|
|
|
Jami is free software for universal communication which respects freedoms and privacy of its users.
|
|
|
|
|
|
|
|
Its main goal is to provide a communication framework and end-user applications to make audio or video calls, send text messages and make generic data transfers. It makes this possible via multiple paradigms: a modern decentralized approach using a DHT to find peers or classical centralized SIP as a soft-phone. The domain of usage is not limited to physical users, it also includes integration with connected objects (IoT).
|
|
|
|
|
|
|
|
Available on all major platforms, this free software project is led by [Savoir-faire Linux](https://www.savoirfairelinux.com/en/) - a Canadian/Quebecois GNU/Linux consulting company - and is supported by the global community.
|
|
|
|
|
|
|
|
As a free software its sources are licensed under the [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.html).
|
|
|
|
|
|
|
|
### Contributions, help and suggestions are very welcome!
|
|
|
|
|
|
|
|
Feel free to open tickets on our [Gitlab](https://git.jami.net), help us with the translation, documentation, packaging, code, tests, etc.
|
|
|
|
|
|
|
|
You can contact us:
|
|
|
|
|
|
|
|
- via <https://git.jami.net>
|
|
|
|
- via IRC: **<span dir="">#</span>jami** on [Libera.Chat](https://web.libera.chat)
|
|
|
|
- via Matrix: **<span dir="">#</span>jami:matrix.org**, bridged with the above IRC channel
|
|
|
|
- by sending a mail to the Jami mailing list, [jami@gnu.org](https://lists.gnu.org/mailman/listinfo/jami).
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## End user notes
|
|
|
|
|
|
|
|
[User manual](user-manual)
|
|
|
|
|
|
|
|
This wiki contains technical documentation and resources for anyone who wants to understand how Jami works or if you want to develop something with the platform. If you are a end-user, please refer to our [website](https://jami.net) or the [FAQ](https://git.jami.net/savoirfairelinux/ring-project/wikis/tutorials/Frequently-Asked-Questions).
|
|
|
|
|
|
|
|
Also, if you prefer to build your binaries from source, please refer to the READMEs in repo.
|
|
|
|
|
|
|
|
Also, you can see features by client via [this page](https://git.jami.net/savoirfairelinux/ring-project/wikis/features/All-features-by-client)
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## How to build
|
|
|
|
|
|
|
|
How to build from source for GNU/Linux:\
|
|
|
|
<https://git.jami.net/savoirfairelinux/jami-client-qt/-/blob/master/INSTALL.md>
|
|
|
|
|
|
|
|
## Technical documentation
|
|
|
|
|
|
|
|
The technical documentation is mainly available [here](https://git.jami.net/savoirfairelinux/ring-project/wikis/technical/0.-Introduction) and [here](https://git.jami.net/savoirfairelinux/ring-project/wikis/pages)
|
|
|
|
|
|
|
|
But this is the main parts:
|
|
|
|
|
|
|
|
+ [OpenDHT](https://opendht.net), a DHT library to provide the basis of our distributed network
|
|
|
|
+ [Nameserver](https://git.jami.net/savoirfairelinux/ring-nameservice), (optional) is our registration system based upon an Ethereum Blockchain, but anyone can implement theirs using the following informations:
|
|
|
|
- Description of the [REST API for name query](technical/Name-Server-Protocol)
|
|
|
|
+ The daemon in charge of the accounts management, SIP features, crypto, video, etc
|
|
|
|
+ The clients for all platform to interact with the daemon.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
## Resources for contributors
|
|
|
|
|
|
|
|
- Auto-generated (Doxygen) [Daemon code documentation](https://docs.jami.net/doxygen/daemon/)
|
|
|
|
- Auto-generated (Doxygen) [LRC API documentation](https://docs.jami.net/doxygen/lrc/)
|
|
|
|
- Testing (LCOV) [Daemon coverage](https://docs.jami.net/coverage)
|
|
|
|
|
|
|
|
### Development Processes and Contributing
|
|
|
|
|
|
|
|
- The [Release Process](technical/release-process)
|
|
|
|
- [Reporting Bugs and Enhancements](tutorials/Bug-report-guide)
|
|
|
|
- [Working with Gerrit](tutorials/Working-with-gerrit), our Git repositories manager and code-review tool for all submitted patches |
|
|
\ No newline at end of file |
