From 2b360599fa2bdc3efa44fc18f95ef15263c19d6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Blin?= <sebastien.blin@savoirfairelinux.com> Date: Fri, 12 Aug 2022 13:16:34 -0400 Subject: [PATCH] misc: update README Change-Id: I9a71b4482d8a990bf4197273a0ace6e8c04c388c --- README.md | 24 +++++++++++++++++++++++- README.txt | 22 ---------------------- 2 files changed, 23 insertions(+), 23 deletions(-) delete mode 100644 README.txt diff --git a/README.md b/README.md index 7824587f..f4f9b20c 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# jaas-server +# Jami-web + +Jami-web is a web server that starts a Dameon on NodeJS express server and serve a React web client. + +The first milestone is to allow user with LDAP credentials to connect to the account using JAMS service and start chatting with their contacts using instant messaging. + +Next step will be to implement a video protocol such as WebRTC to allow audio and video calls from the users browser to another Jami contact allowing cross-platform communications. + +# Main dependencies + +* Jami Daemon with NodeJS bindings (https://review.jami.net/admin/repos/jami-daemon), +* NodeJS v16+ ++ Swig 4.1.0 + +# How to start the server + +After building the Jami daemon you can use the following command to start the node js server using the LD_LIBRARY_PATH + +Where $PATH_TO_JAMI_PROJECT is the path to the shared library of your Jami daemon + +LD_LIBRARY_PATH=$PATH_TO_JAMI_PROJECT/ring-project/install/daemon/lib node + +To build the dring.node Javascript interface to talk to the daemon api go to the daemon repo and use ./configure --with-nodejs then execute make -j4 to build the daemon diff --git a/README.txt b/README.txt deleted file mode 100644 index 51388abb..00000000 --- a/README.txt +++ /dev/null @@ -1,22 +0,0 @@ -# Jami-web - -Jami-web is a web server that starts a Dameon on NodeJS express server and serve a React web client. - -The first milestone is to allow user with LDAP credentials to connect to the account using JAMS service and start chatting with their contacts using instant messaging. - -Next step will be to implement a video protocol such as WebRTC to allow audio and video calls from the users browser to another Jami contact allowing crossplateform communications. - -# Main dependencies - -* Jami Deamon with NodeJS bindings (https://review.jami.net/admin/repos/jami-daemon), -* NodeJS v16+ - -# How to start the server - -After building the Jami daemon you can use the following command to start the node js server using the LD_LIBRARY_PATH - -Where $PATH_TO_JAMI_PROJECT is the path to the shared library of your Jami daemon - -LD_LIBRARY_PATH=$PATH_TO_JAMI_PROJECT/ring-project/install/daemon/lib node - -To build the dring.node Javascript interface to talk to the daemon api go to the daemon repo and use ./configure --with-nodejs then execute make -j4 to build the daemon -- GitLab