Merge branch 'devel'

INSTALL.md

@@ -97,6 +97,9 @@ See [instructions](./docker/README.md)
 
 5. Test your installation by pointing your browser to [http://localhost:6060/](http://localhost:6060/). The static files from the `-static_data` path are served at web root `/`. You can change this by editing the line `static_mount` in the config file.
 
+If you are running Tinode alongside another webserver, such as Apache or nginx, keep in mind that you need to launch the webapp from the URL served by Tinode. Otherwise it won't work.
+
+
 ## Running a Cluster
 
 - Install and run the database, run DB initializer, unpack JS files as described in the previous section. Both MySQL and RethinkDB supports [cluster](https://www.mysql.com/products/cluster/) [mode](https://www.rethinkdb.com/docs/start-a-server/#a-rethinkdb-cluster-using-multiple-machines). You may consider it for added resiliency.

README.md

@@ -2,16 +2,17 @@
 
 <img src="docs/logo.svg" align="left" width=128 height=128> Instant messaging server. Backend in pure [Go](http://golang.org) (license [GPL 3.0](http://www.gnu.org/licenses/gpl-3.0.en.html)), client-side binding in Java, Javascript, and Swift, as well as [gRPC](https://grpc.io/) client support for C++, C#, Go, Java, Node, PHP, Python, Ruby, Objective-C, etc. (license [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)). Wire transport is JSON over websocket (long polling is also available) for custom bindings, or [protobuf](https://developers.google.com/protocol-buffers/) with gRPC. Persistent storage [RethinkDB](http://rethinkdb.com/) and MySQL. A third-party [DynamoDB adapter](https://github.com/riandyrn/chat/tree/master/server/db/dynamodb) also exists. Other databases can be supported by writing custom adapters.
 
-Tinode is *not* XMPP/Jabber. It is *not* compatible with XMPP. It's meant as a replacement for XMPP. On the surface it's a lot like open source WhatsApp or Telegram.
+Tinode is *not* XMPP/Jabber. It is *not* compatible with XMPP. It's meant as a replacement for XMPP. On the surface, it's a lot like open source WhatsApp or Telegram.
 
-Version 0.16. This is beta-quality software: feature-complete but probably with a few bugs. Follow [instructions](INSTALL.md) to install and run. Read [API documentation](docs/API.md).
+Version 0.16. This is beta-quality software: feature-complete but probably with a few bugs. Follow [instructions](INSTALL.md) to install and run or use one of the cloud services below. Read [API documentation](docs/API.md).
 
+<img src="docs/app-store.svg" style="opacity:0.35" height=36> <a href="https://play.google.com/store/apps/details?id=co.tinode.tindroidx"><img src="docs/play-store.svg" height=36></a> <a href="https://web.tinode.co/"><img src="docs/web-app.svg" height=36></a>
 
 ## Why?
 
-The promise of [XMPP](http://xmpp.org/) was to deliver federated instant messaging: anyone would be able to spin up an IM server capable of exchanging messages with any other XMPP server in the world. Unfortunately XMPP never delivered on this promise. Instant messengers are still a bunch of incompatible walled gardens, similar to what AoL of the late 1990s was to the open Internet.
+The promise of [XMPP](http://xmpp.org/) was to deliver federated instant messaging: anyone would be able to spin up an IM server capable of exchanging messages with any other XMPP server in the world. Unfortunately, XMPP never delivered on this promise. Instant messengers are still a bunch of incompatible walled gardens, similar to what AoL of the late 1990s was to the open Internet.
 
-The goal of this project is to actually deliver on XMPP's original vision: create a modern open platform for federated instant messaging with emphasis on mobile communication. A secondary goal is to create a decentralized IM platform which is much harder to track and block by the governments.
+The goal of this project is to deliver on XMPP's original vision: create a modern open platform for federated instant messaging with an emphasis on mobile communication. A secondary goal is to create a decentralized IM platform that is much harder to track and block by the governments.
 
 
 ## Getting support
@@ -21,38 +22,46 @@ The goal of this project is to actually deliver on XMPP's original vision: creat
 * For bugs and feature requests [open an issue](https://github.com/tinode/chat/issues/new).
 
 
-## Demo
+## Public service
+
+A public Tinode service is now available. You can register and use it just like any other instant messenger. Keep in mind that demo accounts present in [sandbox](https://sandbox.tinode.co/) are not available in the public service. You must register an account using valid email in order to use the service.
 
 ### Web
 
-TinodeWeb, a single page web app, is usually available at https://web.tinode.co/ ([source](https://github.com/tinode/webapp/)).
+TinodeWeb, a single page web app, is available at https://web.tinode.co/ ([source](https://github.com/tinode/webapp/)). See screenshots below. Currently available in English, Simplified Chinese, Russian. More translations are welcome.
 
-Login as one of `alice`, `bob`, `carol`, `dave`, `frank`. Password is `<login>123`, e.g. login for `alice` is `alice123`. You can discover other users by email or phone by prefixing them with `email:` or `tel:` respectively. Emails are `<login>@example.com`, e.g. `[email protected]`, phones are `+17025550001` through `+17025550009`.
+### Android
 
-If you register a new account you are asked for an email address to send validation code to. For demo purposes you may use `123456` as a universal validation code. The code you get in the email is also valid.
+[Tindroid](https://github.com/tinode/tindroid) is stable and functional. See the screenshots below. A [debug APK](https://github.com/tinode/tindroid/releases/latest) is provided for convenience. Currently available in English, Russian. More translations are welcome.
 
-[Docker images](https://hub.docker.com/u/tinode/) with the same demo are available.
 
-### Android
+### iOS
 
-[Tindroid](https://github.com/tinode/tindroid) is stable and functional. See screenshots below. A [debug APK](https://github.com/tinode/tindroid/releases/latest) is provided for convenience.
+[Tinode for iOS](https://apps.apple.com/app/reference-to-tinodios-here/id123) a.k.a. Tinodios is stable and functional ([source](https://github.com/tinode/ios)). See the screenshots below. Currently available in English, Simplified Chinese. More translations are welcome.
 
-### Command Line
 
-A text-only [command line client](./tn-cli) implements every possible command.
+### Android
 
-### Notes
+[Tinode for Android](https://play.google.com/store/apps/details?id=co.tinode.tindroid) a.k.a. Tindroid is stable and functional ([source](https://github.com/tinode/tindroid)). See the screenshots below.
 
-* The demo server is reset (all data wiped) every night at 3:15am Pacific time. An error message `User not found or offline` means the server was reset while you were connected. If you see it on the web, reload and relogin. On Android log out and re-login. If the database was changed, delete the app then reinstall.
 
-* User `Tino` is a [basic chatbot](./chatbot) which responds with a [random quote](http://fortunes.cat-v.org/) to any message.
+## Demo/Sandbox
 
-* As generally accepted, when you register a new account you are asked for an email address. The server will send an email with a verification code to that address and you can use it to validate the account. To make things easier for testing, the server will also accept `123456` as a verification code. Remove line `"debug_response": "123456"` from `tinode.conf` to disable this option.
+A sandboxed demo service is available at https://sandbox.tinode.co/.
+
+Log in as one of `alice`, `bob`, `carol`, `dave`, `frank`. Password is `<login>123`, e.g. login for `alice` is `alice123`. You can discover other users by email or phone by prefixing them with `email:` or `tel:` respectively. Emails are `<login>@example.com`, e.g. `[email protected]`, phones are `+17025550001` through `+17025550009`.
 
-* The demo server is configured to use [ACME](https://letsencrypt.org/) TLS [implementation](https://godoc.org/golang.org/x/crypto/acme) with hard-coded requirement for [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication). If you are unable to connect then the most likely reason is your TLS client's missing support for SNI. Use a different client.
+If you register a new account you are asked for an email address to send validation code to. For demo purposes you may use `123456` as a universal validation code. The code you get in the email is also valid.
 
-* The demo uses a single minified javascript bundle and minified css. The un-minified version is available at https://web.tinode.co/index-dev.html
+### Sandbox Notes
 
+* The sandbox server is reset (all data wiped) every night at 3:15am Pacific time. An error message `User not found or offline` means the server was reset while you were connected. If you see it on the web, reload and relogin. On Android log out and re-login. If the database was changed, delete the app then reinstall.
+* Sandbox user `Tino` is a [basic chatbot](./chatbot) which responds with a [random quote](http://fortunes.cat-v.org/) to any message.
+* As generally accepted, when you register a new account you are asked for an email address. The server will send an email with a verification code to that address and you can use it to validate the account. To make things easier for testing, the server will also accept `123456` as a verification code. Remove line `"debug_response": "123456"` from `tinode.conf` to disable this option.
+* The sandbox server is configured to use [ACME](https://letsencrypt.org/) TLS [implementation](https://godoc.org/golang.org/x/crypto/acme) with hard-coded requirement for [SNI](https://en.wikipedia.org/wiki/Server_Name_Indication). If you are unable to connect then the most likely reason is your TLS client's missing support for SNI. Use a different client.
+* The default web app loads a single minified javascript bundle and minified CSS. The un-minified version is also available at https://sandbox.tinode.co/index-dev.html
+* [Docker images](https://hub.docker.com/u/tinode/) with the same demo are available.
+* You are welcome to test your client software against the sandbox, hack it, etc. No DDoS-ing though please.
 
 ## Features
 
@@ -80,18 +89,18 @@ A text-only [command line client](./tn-cli) implements every possible command.
 * Ability to block unwanted communication server-side.
 * Anonymous users (important for use cases related to tech support over chat).
 * Android and [web](https://caniuse.com/#feat=push-api) push notifications using [FCM](https://firebase.google.com/docs/cloud-messaging/).
-* Storage and out of band transfer of large objects like video files using local file system or Amazon S3.
-* Plugins to extend functionality like enabling chat bots.
+* Storage and out of band transfer of large objects like video files using a local file system or Amazon S3.
+* Plugins to extend functionality like enabling chatbots.
 
 ### Planned
 
 * [Federation](https://en.wikipedia.org/wiki/Federation_(information_technology)).
 * End to end encryption with [OTR](https://en.wikipedia.org/wiki/Off-the-Record_Messaging) for one-on-one messaging and undecided method for group messaging.
-* Group messaging with unlimited number (or hundreds of thousands) of members with bearer token access control.
+* Group messaging with an unlimited number (or hundreds of thousands) of members with bearer token access control.
 * Hot standby.
 * Different levels of message persistence (from strict persistence to "store until delivered" to purely ephemeral messaging).
 
-## Third Party Licenses
+## Third-Party Licenses
 
 * Demo avatars and some other graphics are from https://www.pexels.com/ under [CC0](https://www.pexels.com/photo-license/) license.
 * Web and Android background patterns are from http://subtlepatterns.com/ under [CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) license.
@@ -136,5 +145,7 @@ Words 'chat' and 'instant messaging' in Chinese, Russian, Persian and a few othe
 * پیام‌رسانی فوری گپ
 * تراسل فوري
 * Nhắn tin tức thời
-* Mensageiro instantâneo
-* Pesan instan
+* anlık mesajlaşma sohbet
+* mensageiro instantâneo
+* pesan instan
+* mensajería instantánea

docker/README.md

@@ -106,8 +106,10 @@ You can specify the following environment variables when issuing `docker run` co
 | `AWS_REGION` | string |  | AWS Region when using `s3` media handler |
 | `AWS_S3_BUCKET` | string |  | Name of the AWS S3 bucket when using `s3` media handler |
 | `AWS_SECRET_ACCESS_KEY` | string |  | AWS [Secret Access Key](https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/) when using `s3` media handler |
+| `CLUSTER_SELF` | string |  | Node name if the server is running in a Tinode cluster |
 | `DEBUG_EMAIL_VERIFICATION_CODE` | string |  | Enable dummy email verification code, e.g. `123456`. Disabled by default (empty string). |
 | `EXT_CONFIG` | string |  | Path to external config file to use instead of the built-in one. If this parameter is used all other variables except `RESET_DB`, `FCM_SENDER_ID`, `FCM_VAPID_KEY` are ignored. |
+| `EXT_STATIC_DIR` | string |  | Path to external directory containing static data (e.g. Tinode Webapp files) |
 | `FCM_CRED_FILE` | string |  | Path to json file with FCM server-side service account credentials which will be used to send push notifications. |
 | `FCM_SENDER_ID` | string |  | FCM sender ID for receiving push notifications in the web client |
 | `FCM_VAPID_KEY` | string |  | Also called 'Web Client certificate' in the FCM console. Required by the web client to receive push notifications. |
@@ -119,6 +121,7 @@ You can specify the following environment variables when issuing `docker run` co
 | `SAMPLE_DATA` | string |  _see comment_ | File with sample data to load. Default `data.json` when resetting or generating new DB, none when upgrading. Use `-` to disable |
 | `SMTP_DOMAINS` | string |  | White list of email domains; when non-empty, accept registrations with emails from these domains only (email verification). |
 | `SMTP_HOST_URL` | string | `'http://localhost:6060/'` | URL of the host where the webapp is running (email verification). |
+| `SMTP_LOGIN` | string |  | Optional login to use for authentication with the SMTP server (email verification). If login is missing, `addr-spec` part of `SMTP_SENDER` will be used: e.g. if `SMTP_SENDER` is `'"John Doe" <[email protected]>'`, `[email protected]` will be used as login. |
 | `SMTP_PASSWORD` | string |  | Password to use for authentication with the SMTP server (email verification). |
 | `SMTP_PORT` | number |  | Port number of the SMTP server to use for sending verification emails, e.g. `25` or `587`. |
 | `SMTP_SENDER` | string |  | [RFC 5322](https://tools.ietf.org/html/rfc5322) email address to use in the `FROM` field of verification emails and for authentication with the SMTP server, e.g. `'"John Doe" <[email protected]>'`. |

docker/chatbot/Dockerfile

@@ -2,10 +2,10 @@
 
 FROM python:slim
 
-ARG VERSION=0.15
+ARG VERSION=0.16
 ENV VERSION=$VERSION
 
-LABEL maintainer="Gene Sokolov <gene@tinode.co>"
+LABEL maintainer="Tinode Team <info@tinode.co>"
 LABEL name="TinodeChatbot"
 LABEL version=$VERSION
 

docker/tinode/Dockerfile

@@ -11,10 +11,10 @@
 
 FROM alpine:latest
 
-ARG VERSION=0.15
+ARG VERSION=0.16.2
 ENV VERSION=$VERSION
 
-LABEL maintainer="Gene Sokolov <gene@tinode.co>"
+LABEL maintainer="Tinode Team <info@tinode.co>"
 LABEL name="TinodeChatServer"
 LABEL version=$VERSION
 

docker/tinode/config.template

@@ -75,6 +75,7 @@
 				"host_url": "$SMTP_HOST_URL",
 				"smtp_server": "$SMTP_SERVER",
 				"smtp_port": "$SMTP_PORT",
+				"login": "$SMTP_LOGIN",
 				"sender": "$SMTP_SENDER",
 				"sender_password": "$SMTP_PASSWORD",
 				"validation_body_templ": "./templ/email-validation-body.templ",

docker/tinode/entrypoint.sh

@@ -41,18 +41,26 @@ else
 	done < config.template
 fi
 
+# If external static dir is defined, use it.
+# Otherwise, fall back to "./static".
+if [ ! -z "$EXT_STATIC_DIR" ] ; then
+  STATIC_DIR=$EXT_STATIC_DIR
+else
+  STATIC_DIR="./static"
+fi
+
 # Load default sample data when generating or resetting the database.
 if [[ -z "$SAMPLE_DATA" && "$UPGRADE_DB" = "false" ]] ; then
 	SAMPLE_DATA="$DEFAULT_SAMPLE_DATA"
 fi
 
 # If push notifications are enabled, generate client-side firebase config file.
 if [ ! -z "$FCM_PUSH_ENABLED" ] ; then
-	# Write client config to static/firebase-init.js
-	echo "const FIREBASE_INIT={messagingSenderId: \"$FCM_SENDER_ID\", messagingVapidKey: \"$FCM_VAPID_KEY\"};"$'\n' > static/firebase-init.js
+	# Write client config to $STATIC_DIR/firebase-init.js
+	echo "const FIREBASE_INIT={messagingSenderId: \"$FCM_SENDER_ID\", messagingVapidKey: \"$FCM_VAPID_KEY\"};"$'\n' > $STATIC_DIR/firebase-init.js
 else
 	# Create an empty firebase-init.js
-	echo "" > static/firebase-init.js
+	echo "" > $STATIC_DIR/firebase-init.js
 fi
 
 # Initialize the database if it has not been initialized yet or if data reset/upgrade has been requested.
@@ -67,5 +75,11 @@ if [ -s /botdata/tino-password ] ; then
 	./credentials.sh /botdata/.tn-cookie < /botdata/tino-password
 fi
 
+args=("--config=${CONFIG}" "--static_data=$STATIC_DIR")
+
+# Maybe set node name in the cluster.
+if [ ! -z "$CLUSTER_SELF" ] ; then
+  args+=("--cluster_self=$CLUSTER_SELF")
+fi
 # Run the tinode server.
-./tinode --config=${CONFIG} --static_data=static 2> /var/log/tinode.log
+./tinode "${args[@]}" 2> /var/log/tinode.log