diff --git a/README.md b/README.md index 22021b50..445d0c89 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ For demo access and other instructions [see here](https://github.com/tinode/chat ## Installing and running -This is NOT a standalone app, this is just a frontend, a client. It requires a [backend](https://github.com/tinode/chat/). See [installation instructions](https://github.com/tinode/chat/blob/master/INSTALL.md). +This is NOT a standalone app, this is just a frontend, a client. It requires a [backend](https://github.com/tinode/chat/). See [installation instructions](https://github.com/tinode/chat/blob/master/INSTALL.md). See instructions for [enabling push notifications](push.md). ## Getting support @@ -56,18 +56,6 @@ More translations are welcome. See [instructions](https://github.com/tinode/chat * [Fonts](https://fonts.google.com/) and [icons](https://google.github.io/material-design-icons/#icon-font-for-the-web) from Google under [license](https://developers.google.com/terms) which permits commercial and non-commercial use. * Push notifications built with https://firebase.google.com/. -## Push notifications - -If you want to use the app with your own server and want web push notification to work you have to set them up: - -* Register at https://firebase.google.com/, set up the project if you have not done so already. -* Follow instructions to create a web application https://support.google.com/firebase/answer/9326094 in your project. -* Follow instructions at https://support.google.com/firebase/answer/7015592 to get a Firebase configuration object ("Firebase SDK snippet"). -* Locate `firebase-init.js` in the root folder of your copy of TinodeWeb app. Copy-paste the following keys from the configuration object to `firebase-init.js`: `apiKey`, `messagingSenderId`, `projectId`, `appId` (you may copy all keys). -* Copy `Web Push certificate` (Project Settings -> Cloud Messaging -> Web configuration -> Web Push certificates) to `messagingVapidKey` field in `firebase-init.js`. -* Double check that `firebase-init.js` contains the following keys: `apiKey`, `messagingSenderId`, `projectId`, `appId`, `messagingVapidKey`. The file may contain other optional keys. -* Copy Google-provided server key to `tinode.conf`, see details [here](https://github.com/tinode/chat/blob/master/docs/faq.md#q-how-to-setup-fcm-push-notifications). - ## Responsive design ### Desktop screenshot diff --git a/push.md b/push.md new file mode 100644 index 00000000..3e71e57a --- /dev/null +++ b/push.md @@ -0,0 +1,11 @@ +# Push notifications + +If you want to use the app with your own server and want web push notification to work you have to set them up: + +* Register at https://firebase.google.com/, set up the project if you have not done so already. +* Follow instructions to create a web application https://support.google.com/firebase/answer/9326094 in your project. +* Follow instructions at https://support.google.com/firebase/answer/7015592 to get a Firebase configuration object ("Firebase SDK snippet"). +* Locate `firebase-init.js` in the root folder of your copy of TinodeWeb app. Copy-paste the following keys from the configuration object to `firebase-init.js`: `apiKey`, `messagingSenderId`, `projectId`, `appId` (you may copy all keys). +* Copy `Web Push certificate` (Project Settings -> Cloud Messaging -> Web configuration -> Web Push certificates) to `messagingVapidKey` field in `firebase-init.js`. +* Double check that `firebase-init.js` contains the following keys: `apiKey`, `messagingSenderId`, `projectId`, `appId`, `messagingVapidKey`. The file may contain other optional keys. +* Copy Google-provided server key to `tinode.conf`, see details [here](https://github.com/tinode/chat/blob/master/docs/faq.md#q-how-to-setup-fcm-push-notifications).