chatcola-server v3.1.8
This repository hosts the chatcola server needed to self-host reliance and storage of your messaging.
Getting started
With docker (the easier way)
- run
docker install chatcola/chatcola - run
docker run -e THIS_INSTANCE_ADDRESS={{your instance address here}}
Without docker
Install node.js 14:
Linux / MacOS:
curl -s https://install-node.now.sh | bash -s --
Windows: download installer from here
Install chatcola p2p server:
npm install -g chatcola-serverRun the server
chatcola-serverIf you plan to use the server for longer (i.e. raspberry pi), daemonize it with some process manager, for example:
$ npm install -g pm2
$ pm2 run "chatcola-server"you will be asked for instance address, give it a string that's easy for you to remember (it can be anything provided no one has taken it before, i.e. "foobar") -
To host the chatroom on your instance insert webrtc:{{YOUR INSTANCE ADDRESS GOES HERE}} when creating a chatroom at chatcola.com/start
For example, if you have address foobar, then you will have to insert webrtc:foobar
If you want to change the address later run the server with the --resetAddress flag:
chatcola-server --resetAddressyou will be then guided through the process of assigning address again. Note that all chatrooms created beforehand will be left fatherless and impossible to use again.
Hosting a http instance
This comes a bit harder than hosting a webrtc instance, but provides a more performant and probably more stable experience.
You'll need a linux computer (probably a VPS) with a public IP
Point your domain name (you can get a free one at Freenom.com) to the VPS.
Make a
~/.chatcola-httpdirectoryCopy your SSL cert files (they need to be named
fullchain.pemfor the cert andprivkey.pemfor the private key) to~/.chatcola-httpdirectoryAt this point you should have already installed
chatcola-serverfrom npm and prepared your home directory to look like so:
/home/<your-username>/
├── .chatcola-http/ # <----- notice the dot
│ ├── privkey.pem
| |── fullchain.pemYou are now ready to launch the chatcola server.
Run
chatcola-server-http
Available options are:
PORT- if using this, then also remember to change the port from7777inTHIS_INSTANCE_ADDRESS. So if you setPORTto be, for example,5050and you have domainexample.com, you have to setTHIS_INSTANCE_ADDRESStoexample.com:5050. You can do a reverse proxy with nginx/apache/caddy and bind port 443 to your chatcola instance, then you won't have to specify the port in this variable.SHOULD_REPORT_ERRORSSet this tofalseto disable our sentry.
Both of them should be set as environent variables.
Building from source
- Clone the repository and run
npm install - Make the script executable -
chmod +x ./scripts/build - Either run
./scripts/buildto build for webrtc or./scripts/build httpfor http. Your build will be inbuild/p2porbuild/http.
License
This program is free software. For alternate licensing arrangements contact us at freedom@chatcola.com
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago