microsoft365.remote-phone-book

This application creates remote phone books from Microsoft 365 contacts for use for IP phones

Setup

Install curl and git

1. To update the contents database of your Debian Linux package repository, use the apt update command:

   sudo apt update
   sudo apt install -y curl git

Install Node 16.x (example for debian 11)

1. Install Node.js 16 on Debian 11 once the system has been updated by first installing the necessary repository:

   curl -sL https://deb.nodesource.com/setup_16.x | sudo bash -

2. After you’ve added the repository, you may start installing Node.js 16 on Debian 11:

   sudo apt -y install nodejs

3. Check the Node.js version installed:

   node -v

Install the microsoft365.remote-phone-book repository

1. Clone the microsoft365.remote-phone-book repository

git clone https://github.com/Doggi/microsoft365.remote-phone-book.git

2. Change the dir

cd microsoft365.remote-phone-book

3. Install dependencies

npm install

Register the application by Microsoft 365

first you need to register an application by Microsoft 365 to get the following authentication informations

• TENANT_ID
• CLIENT_ID
• CLIENT_SECRET
• AAD_ENDPOINT
• GRAPH_ENDPOINT

1. follow the instruction https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app

2. follow the instruction https://docs.microsoft.com/en-us/azure/active-directory/develop/tutorial-v2-nodejs-console#register-the-application

3. Create a configuration file

cp config/default.json.example config/default.json

4. Enter the microsoft365 credentials

nano config/default.json

5. add phone book(s)

nano config/default.json

A phonebook entry as three attributes.

user: is the userPrincipalName in the most cases its the email address
phonebookName: is the name of the phone book you can type what you want. In Yealink phone book will this used as the display phone book name.
phonebookFile: is the filename of the phonebook how the app will save it in the folder remote_phone_books and how you can access it over http
phonebookType: (optional) is the type of phonebook that will be use. Currently the following phonebooks implemented:

• YealinkPhoneBook (default value)
• YealinkPhoneBookWithType

...
"phonebooks": [
    {
        "user": "example@mail.com",
        "phonebookName": "Example Phone book",
        "phonebookFile": "example_book.xml"
    },
    {
        "user": "example2@mail.com",
        "phonebookName": "Example Phone book 2",
        "phonebookFile": "example_book_2.xml"
        "phonebookType": "YealinkPhoneBook"
    }
]
...

If you want you can also increase or decrease the refresh timer. You have to change the minute number in service.refresh.

...
"service": {
    "refresh": 60 // in minutes
},
...

Start app and file server

You can start the app for the phone book creation with

npm run start:prod

and the file server with

npm run server:file

Best way to run The best way to start both, app and file server, is to use pm2. In this repository is a predefined configuraion file.

1. install pm2 global

sudo npm install -location=global pm2

2. start the app and file server

pm2 start pm2.config.js

3. Starting PM2 on Boot

pm2 startup
pm2 start pm2.config.js
pm2 save

With the following command you can see the status of the apps

pm2 status pm2.config.js

and if you are a nerd use this command ;)

pm2 monit

access Remote phone books

The File server will be avaiable under the port 8080, so you can open the url for example http://localhost:8080 in your browser. Now you should see all defined phone books.

Last step is to config you IP Phones with the remote phone books.

Enjoy

License

MIT License

Copyright (c) 2023 Doggi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.