jami
/
jami-docs
mirror of https://git.jami.net/savoirfairelinux/jami-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

misc: remove ring-client-gnome and Ring occurences 

Change-Id: Ifbe372be9bc9f5c915929bb52e29a1583045b80e
This commit is contained in:
Sébastien Blin 2024-05-14 12:52:46 -04:00
parent d2d01055ce
commit 44acbbee3f
10 changed files with 25 additions and 197 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
developer/jami-concepts/account-management.md
View File

@ -32,7 +32,7 @@ In cx.ring.Ring.ConfigurationManager:
</method> </method>
``` ```
The details can be retrieven from the method `getAccountTemplate(type)` with `type=RING` or `type=SIP`. For example, this is the following code used in LRC. The details can be retrieven from the method `getAccountTemplate(type)` with `type=JAMI` or `type=SIP`. For example, this is the following code used in LRC.
```cpp ```cpp
std::string std::string
@ -45,9 +45,9 @@ NewAccountModel::createNewAccount(profile::Type type,
MapStringString details = type == profile::Type::SIP? MapStringString details = type == profile::Type::SIP?
ConfigurationManager::instance().getAccountTemplate("SIP") : ConfigurationManager::instance().getAccountTemplate("SIP") :
ConfigurationManager::instance().getAccountTemplate("RING"); ConfigurationManager::instance().getAccountTemplate("JAMI");
using namespace libjami::Account; using namespace libjami::Account;
details[ConfProperties::TYPE] = type == profile::Type::SIP? "SIP" : "RING"; details[ConfProperties::TYPE] = type == profile::Type::SIP? "SIP" : "JAMI";
details[ConfProperties::DISPLAYNAME] = displayName.c_str(); details[ConfProperties::DISPLAYNAME] = displayName.c_str();
details[ConfProperties::ALIAS] = displayName.c_str(); details[ConfProperties::ALIAS] = displayName.c_str();
details[ConfProperties::UPNP_ENABLED] = "true"; details[ConfProperties::UPNP_ENABLED] = "true";
@ -121,7 +121,7 @@ In cx.ring.Ring.ConfigurationManager:
<method name="setAccountDetails" tp:name-for-bindings="setAccountDetails"> <method name="setAccountDetails" tp:name-for-bindings="setAccountDetails">
<tp:docstring> <tp:docstring>
Send new account parameters, or account parameters changes, to the core. The hash table is not required to be complete, only the updated parameters may be specified. Send new account parameters, or account parameters changes, to the core. The hash table is not required to be complete, only the updated parameters may be specified.
<tp:rationale>Account settings are written to the configuration file when ring properly quits.</tp:rationale> <tp:rationale>Account settings are written to the configuration file when the app properly quits.</tp:rationale>
<tp:rationale>After calling this method, the core will emit the signal <tp:member-ref>accountDetailsChanged</tp:member-ref> with the updated data. The client must subscribe to this signal and use it to update its internal data structure.</tp:rationale> <tp:rationale>After calling this method, the core will emit the signal <tp:member-ref>accountDetailsChanged</tp:member-ref> with the updated data. The client must subscribe to this signal and use it to update its internal data structure.</tp:rationale>
</tp:docstring> </tp:docstring>
<arg type="s" name="accountID" direction="in"> <arg type="s" name="accountID" direction="in">

2
developer/jami-concepts/banned-contacts.md
View File

@ -13,7 +13,7 @@ Alice and Jessica are friends, and like all good friends do, they use
Jami to communicate. They are both Jami contact of each other, so Alice Jami to communicate. They are both Jami contact of each other, so Alice
is a contact of Jessica and Jessica is a contact of Alice. Some day is a contact of Jessica and Jessica is a contact of Alice. Some day
however, Jessica does something really bad to Alice and Alice doesn't however, Jessica does something really bad to Alice and Alice doesn't
want to hear from her anymore. Instead of removing Jessica from her Ring want to hear from her anymore. Instead of removing Jessica from her
contacts -- which would still allow Jessica to send her contact contacts -- which would still allow Jessica to send her contact
requests, Alice *bans* Jessica. requests, Alice *bans* Jessica.

2
developer/jami-concepts/contact-management.md
View File

@ -30,7 +30,7 @@ public:
### Get if a contact is present ### Get if a contact is present
Now our presence on the network, it's time to get if somebody is present on the DHT. With the previous section, it's easy to do the reverse process. To know if somebody is present on the DHT (ex: `bf5f1e21d3eb2c1246946aa49d5dcf3e5b9cb1b9`), we have to get value at `bf5f1e21d3eb2c1246946aa49d5dcf3e5b9cb1b9` and retrieve the `DeviceAnnouncement` on this hash. The related code in the ring daemon is in `ringaccount.cpp`: Now our presence on the network, it's time to get if somebody is present on the DHT. With the previous section, it's easy to do the reverse process. To know if somebody is present on the DHT (ex: `bf5f1e21d3eb2c1246946aa49d5dcf3e5b9cb1b9`), we have to get value at `bf5f1e21d3eb2c1246946aa49d5dcf3e5b9cb1b9` and retrieve the `DeviceAnnouncement` on this hash. The related code in the daemon is in `jamiaccount.cpp`:
```cpp ```cpp
auto shared = std::static_pointer_cast<RingAccount>(shared_from_this()); auto shared = std::static_pointer_cast<RingAccount>(shared_from_this());

45
developer/jami-concepts/file-transfer.md
View File

@ -7,28 +7,6 @@ File transfer
How to use it? How to use it?
-------------- --------------
### Gnome
For sending a file on gnome, in a conversation you need to click to the
send file icon at the bottom right of the conversation:
![Gnome_send_file](https://git.jami.net/savoirfairelinux/jami-project/uploads/e7571789effe8641f5ff4117e47f89dd/Gnome_send_file.png)
Then you will see your image as soon as the transfer is finished (and
show images is activated)
![Gnome_image](https://git.jami.net/savoirfairelinux/jami-project/uploads/cc03387d134a9aa71c6deb60ccf53ed8/Gnome_image.png)
On the contrary if you receive a file (and if it's not a picture &lt; 20
Mb), you will have to accept the transfer:
![Gnome_accept](https://git.jami.net/savoirfairelinux/jami-project/uploads/29dd852e062e7bcbcb654e4e7e3f8e47/Gnome_accept.png)
And then the file will be sent. You have the possibility to cancel in a
middle of a transfer.
![Gnome_ongoing](https://git.jami.net/savoirfairelinux/jami-project/uploads/92f319f8a88f75c388020d999f607bdc/Gnome_ongoing.png)
### Android ### Android
When you are talking to somebody on Android, you have the possibility to When you are talking to somebody on Android, you have the possibility to
@ -144,7 +122,7 @@ Note that the stack for the file transfer is:
### Multi devices ### Multi devices
A RING user can link its account to several devices. So, we need to A user can link its account to several devices. So, we need to
implement the transfer when a user send a file to a contact who have implement the transfer when a user send a file to a contact who have
multiple devices linked to this account. multiple devices linked to this account.
@ -162,7 +140,7 @@ devices will have the notification for receiving a file and can
accept/refuse the transfer. The major part of the code for that is in accept/refuse the transfer. The major part of the code for that is in
*data\_transfer.cpp*. *data\_transfer.cpp*.
Now (since <https://gerrit-ring.savoirfairelinux.com/#/c/9327/>), when a Now (since <https://review.jami.net/c/jami-daemon/+/9327>), when a
user send a file, it will request a *PeerConnection* with all peer user send a file, it will request a *PeerConnection* with all peer
devices. And for all connections, we attach a new input stream to have devices. And for all connections, we attach a new input stream to have
the ability to accept/refuse/cancel each transfer separately. the ability to accept/refuse/cancel each transfer separately.
@ -179,34 +157,19 @@ show a sub transfer instead the optimistic later (see TODO list).
### Using another TURN server ### Using another TURN server
Actually the default TURN server is *turn.ring.cx*. But you can host Actually the default TURN server is *turn.jami.net*. But you can host
your own TURN server. For example by running a your own TURN server. For example by running a
[coturn](https://github.com/coturn/coturn) server. [coturn](https://github.com/coturn/coturn) server.
`sudo turnserver -a -v -n -u user:password -r "realm"` `sudo turnserver -a -v -n -u user:password -r "realm"`
Then, you can configure the TURN server in the advanced settings of Then, you can configure the TURN server in the advanced settings of the app.
RING.
Note: this needs some technical knowledges. Moreover, the TURN server Note: this needs some technical knowledges. Moreover, the TURN server
should see the same ip address of your node as the destination node or should see the same ip address of your node as the destination node or
the peer connection will fail (because the authorization will be the peer connection will fail (because the authorization will be
incorrect) incorrect)
Future
------
For now, if a file transfer fails when ongoing, the sender can not resume
the transfer and must relaunch the whole transfer. In the future, there
will be a retry button for resuming the transfer.
Finally, because Jami do not support text conferences (just video
conferences, where there is one master merging slaves SIP calls), there
is no real file transfer in conferences. For now, when you are in a
conference on the gnome client for example: A master, B and C slave. B
will be able to send a file to A the master (C same) A will be able to
send a file to B or to C (just have to select the correct conversation).
### TODO List ### TODO List
1. Use libtorrent? 1. Use libtorrent?

2
developer/jami-concepts/jami-identifiers.md
View File

@ -28,7 +28,7 @@ When displaying a contact:
- If Display name is empty, User ID is shown instead - If Display name is empty, User ID is shown instead
- If both lines have the same content, only the first line is - If both lines have the same content, only the first line is
displayed displayed
- If no photo is available and a registered name (ring) or display name (sip) is available, the first letter of this name can be used to generate a placeholder. Otherwise a generic placeholder is used. - If no photo is available and a registered name (jami) or display name (sip) is available, the first letter of this name can be used to generate a placeholder. Otherwise a generic placeholder is used.
- If no photo is available, a placeholder with an Canonical URI-specific background color can be used: - If no photo is available, a placeholder with an Canonical URI-specific background color can be used:
```java ```java

127
developer/processes/release-process.md
View File

@ -59,129 +59,4 @@ Push tags
Packaging Packaging
--------- ---------
```bash cf [This page](/contribute#Packaging)
git clone ssh://tcohen@gerrit-ring.savoirfairelinux.com:29420/ring
cd ring
git checkout packaging-releases
```
### RPM
```bash
vim ring-daemon.spec
```
```bash
%define version 2.2.0
%define release 1
...
...
...
%changelog
* Tue Apr 14 2015 Thibault Cohen <thibault.cohen@savoirfairelinux.com> - 2.2.0-1
- New upstream version
```
### DEB
```bash
vim debian/changelog
```
```bash
ring-daemon (2.2.0-1) unstable; urgency=medium
[ Thibault Cohen]
* New upstream version
-- Thibault Cohen <thibault.cohen@savoirfairelinux.com> Tue, 14 Apr 2015 12:40:24 -0400
```
### Release
You just have to launch release script. This script launch build,
download and update files and repositories...
```
sflvault connect 525
...
...
cd /root/repos/ring/
./ring-release-daemon.sh
```
## Gnome
```bash
git clone ssh://tcohen@gerrit-sflphone.savoirfairelinux.com:29420/ring-client-gnome
cd ring-client-gnome
git checkout packaging-releases
```
### RPM
vim ring-daemon.spec
```bash
%define version 0.2.1
%define release 1
%define daemon_tag 2.1.0
%define lrc_tag 0.2.1
%define gnome_tag %{version}
...
...
...
%changelog
* Tue Apr 14 2015 Thibault Cohen <thibault.cohen@savoirfairelinux.com> - 0.2.1-1
- New upstream version
```
### DEB
```bash
debian/changelog
```
```bash
ring-gnome (0.2.1-1) unstable; urgency=medium
[ Thibault Cohen]
* New Upstream version
-- Thibault Cohen <thibault.cohen@savoirfairelinux.com> Tue, 14 Apr 2015 13:16:38 -0400
```
```bash
debian/rules
```
```bash
DAEMON_TAG = 2.1.0
LRC_TAG = 0.2.1
GNOME_TAG = $(VER)
```
### Release
You just have to launch release script. This script launch build, download and update files and repositories...
```bash
sflvault connect 525
...
...
cd /root/repos/ring/
./ring-release-gnome.sh
```
------------------------------------------------------------------------
Advertisement
-------------
When the packaging is finished, test that they are installable. Then
announce the release
* on the official website <https://ring.cx>
* on Twitter <https://twitter.com/JoinTheRing>
* by email to ring@lists.savoirfairelinux.net with the subject line: "Ring
Major.Minor.Patch released"

4
jami-extensions/how-it-works.md
View File

@ -35,12 +35,10 @@ In order to a preference modification can take effect the plugin has to be reloa
![client-android-prefs](images/jami-plugins-client-android-prefs.gif) ![client-android-prefs](images/jami-plugins-client-android-prefs.gif)
## Linux/Windows ## Linux/Windows
Similarly, for the client-qt available on Linux and Windows and for the client-gnome available only on Linux, you must go to Prefences, enable plugins if it is disabled, and select a plugins file from your computer. Similarly, for the client-qt available on GNU/Linux and Windows you must go to Prefences, enable plugins if it is disabled, and select a plugins file from your computer.
Each plugin in the shown list is linked to two buttons beeing: Each plugin in the shown list is linked to two buttons beeing:
- Client-qt: a load/unload button and a preferences button; - Client-qt: a load/unload button and a preferences button;
- Client-gnome: a load/unload button and a uninstall button;
For client-gnome it is not possible to change plugin's preferences.
![client-qt-install](images/jami-plugins-client-qt-install.gif) ![client-qt-install](images/jami-plugins-client-qt-install.gif)
![client-qt-prefs](images/jami-plugins-client-qt-prefs.gif) ![client-qt-prefs](images/jami-plugins-client-qt-prefs.gif)

12
jami-extensions/how-to-build.md
View File

@ -197,11 +197,7 @@ For further build instructions, please refer to onnxruntime official [GitHub](ht
To exemplify a plugin build, we will use the GreenScreen plugin available {gitlab-project}`here <jami-plugins>`. To exemplify a plugin build, we will use the GreenScreen plugin available {gitlab-project}`here <jami-plugins>`.
### Linux/Android ### Linux/Android
First you need to go to the plugins repository in your cloned ring-project: First you need to go to the plugins repository in your cloned jami-plugins:
```bash
cd <ring-project>/plugins
```
- Linux - Nvidia GPU - Linux - Nvidia GPU
@ -221,17 +217,17 @@ export PATH=${PATH}:${ANDROID_HOME}/tools:${ANDROID_HOME}/platform-tools:${ANDRO
ANDROID_ABI="<android-architecture-separate-by-space>" python3 build-plugin.py --projects=GreenScreen --distribution=android ANDROID_ABI="<android-architecture-separate-by-space>" python3 build-plugin.py --projects=GreenScreen --distribution=android
``` ```
The GreenScreen.jpl file will be available under `<ring-project/plugins/build/>`. The GreenScreen.jpl file will be available under `<build/>`.
### Windows ### Windows
Windows build of plugins are linked with the daemon repository and its build scripts. So to build our example plugins you have to: Windows build of plugins are linked with the daemon repository and its build scripts. So to build our example plugins you have to:
```bash ```bash
cd <ring-project>/daemon/compat/msvc cd daemon/compat/msvc
python3 winmake.py -fb GreenScreen python3 winmake.py -fb GreenScreen
``` ```
The GreenScreen.jpl file will be available under `<ring-project/plugins/build/>`. The GreenScreen.jpl file will be available under `<build/>`.
Related articles: Related articles:

12
user/bug-report-guide.md
View File

@ -30,8 +30,6 @@ one already.
- {gitlab-project}`The Android client <jami-client-android>` - {gitlab-project}`The Android client <jami-client-android>`
- {gitlab-project}`The Qt client <jami-client-qt>` - {gitlab-project}`The Qt client <jami-client-qt>`
- {gitlab-project}`The GNOME/GTK client <jami-client-gnome>`
(deprecated by {gitlab-project}`the Qt client <jami-client-qt>`)
- {gitlab-project}`The iOS client <jami-client-ios>` - {gitlab-project}`The iOS client <jami-client-ios>`
- {gitlab-project}`The macOS client <jami-client-macos>` - {gitlab-project}`The macOS client <jami-client-macos>`
(deprecated by {gitlab-project}`the Qt client <jami-client-qt>`) (deprecated by {gitlab-project}`the Qt client <jami-client-qt>`)
@ -72,9 +70,8 @@ one already.
- what build you are using (F-Droid, Play Store, App Store, from - what build you are using (F-Droid, Play Store, App Store, from
`dl.jami.net`, your own build, etc.). If you have built your own `dl.jami.net`, your own build, etc.). If you have built your own
version of Jami, please specify the exact Jami Daemon version and version of Jami, please specify the exact Jami Daemon version and
client version (you can obtain it using `jamid -v` and client version (you can obtain it using `jamid -v` and `jami -v`;
`jami-gnome -v` or `jami -v`; but note that our packages are but note that our packages are updated quite often) and the Git commit.
updated quite often) and the Git commit.
- network conditions: are both devices on the same local network? - network conditions: are both devices on the same local network?
Different networks? Is one or both behind NAT? Different networks? Is one or both behind NAT?
Are you using LTE? Are you using WiFi? Are you using LTE? Are you using WiFi?
@ -193,12 +190,11 @@ manually.
Debian/Trisquel/Ubuntu packages, it is located at Debian/Trisquel/Ubuntu packages, it is located at
`/usr/lib/x86_64-linux-gnu/jamid -d -c` or `/usr/lib/x86_64-linux-gnu/jamid -d -c` or
`/usr/libexec/jamid -d -c`. `/usr/libexec/jamid -d -c`.
3. In another terminal, start the client, using e.g. `jami-gnome -d` 3. In another terminal, start the client, using `jami -d`.
or `jami -d`.
To get a backtrace, you can run the program inside GDB: To get a backtrace, you can run the program inside GDB:
`gdb -ex run --args jami -d`, or `gdb -ex run jami-gnome`, or `gdb -ex run --args jami -d`, or
`gdb -ex run --args /usr/libexec/jamid -cd`, depending on the `gdb -ex run --args /usr/libexec/jamid -cd`, depending on the
component you need to debug. component you need to debug.

8
user/jami-distributed-network.md
View File

@ -92,13 +92,13 @@ transaction fee needed to register their username in Jami.
Code of the Ethereum contract, the blockchain genesis file, and the Code of the Ethereum contract, the blockchain genesis file, and the
NodeJS module (HTTP server) can be found here : NodeJS module (HTTP server) can be found here :
[1](https://github.com/savoirfairelinux/ring-nameservice) [1](https://git.jami.net/savoirfairelinux/jami-nameservice)
### Running a Jami Node ### Running a Jami Node
#### Pre-requisites: #### Pre-requisites:
1. Geth 1.8.23+ (download from [HERE](https://geth.ethereum.org/downloads/)) 1. Geth 1.8.23+ (download from [HERE](https://geth.ethereum.org/downloads/))
2. Jami genesis file (download from [HERE](https://github.com/savoirfairelinux/ring-nameservice/blob/master/instructions/genesis.json)) 2. Jami genesis file (download from [HERE](https://git.jami.net/savoirfairelinux/jami-nameservice/blob/master/instructions/genesis.json))
#### Joining the Jami Network #### Joining the Jami Network
@ -110,8 +110,8 @@ The process of joining the Jami network is similar to the process of joining a r
* Example for MacOS (/Users/username/jamichain) * Example for MacOS (/Users/username/jamichain)
* Example for Linux (/home/username/jamichain) * Example for Linux (/home/username/jamichain)
* Example for Windows (C:\Users\username\jamichain) * Example for Windows (C:\Users\username\jamichain)
3. Use geth to initialize the directory you created in (2) by running ```./geth --datadir /home/username/jamichain init genes is.json ``` 3. Use geth to initialize the directory you created in (2) by running ```./geth --datadir /home/username/jamichain init genes is.json ```
4. You can now start geth with the command-line options you need and specifying one of Jami's bootnodes as follows: 4. You can now start geth with the command-line options you need and specifying one of Jami's bootnodes as follows:
``` ```
geth --datadir=/home/username/jamichain --syncmode=full --networkid 1551 --bootnodes "enode://11ba6d3bfdc29a8afb24dcfcf9a08c8008005ead62756eadb363523c2ca8b819efbb264053db3d73949f1375bb3f03090f44cacfb88bade38bb6fc2cb3d890a5@173.231.120.228:30301" console geth --datadir=/home/username/jamichain --syncmode=full --networkid 1551 --bootnodes "enode://11ba6d3bfdc29a8afb24dcfcf9a08c8008005ead62756eadb363523c2ca8b819efbb264053db3d73949f1375bb3f03090f44cacfb88bade38bb6fc2cb3d890a5@173.231.120.228:30301" console