Powered by uWebSockets.js
The intention of our messaging protocol and chat server, which are different from others, is to provide an alternative solution to the wide spread XMPP messaging protocol (and to be honest — the only wide spread ‘standard’ these days).
Read a complete medium post Introducing SAMA about what is SAMA and what problems we are trying to solve with it https://medium.com/sama-communications/introducing-sama-simple-but-advanced-messaging-alternative-chat-server-524a532e2040
- Make sure you have
Node 18installed. - Copy
.env.exampleto.env. - Run
docker-compose upto run dependant services (MongoDB, Minio, Redis) npm installto install dependenciesnpm run migrate-mongo-upto run DB migrationsnpm run startto run server
There are also other components. Make sure to check Deploying SAMA chat server stack: a comprehensive guide
To build and run the SAMA with all dependencies, you can use the following command:
docker-compose -f docker-compose-full.yml up --build
If you only want to run dependency services (for local development without Docker), use this command:
docker-compose up
Run dependency services with SAMA main apps:
RUN_SAMA=true docker-compose up --build
SAMA apps, add these two variables before the launch command:
MacOS
MINIO_ENDPOINT=$(ipconfig getifaddr en0) MINIO_PORT=9010
Windows
$env:MINIO_ENDPOINT = (Get-NetIPAddress | Where-Object { $_.AddressFamily -eq 'IPv4' -and $_.IPAddress -match '^192\.168\.|^10\.|^172\.(1[6-9]|2[0-9]|3[0-1])\.' } | Select-Object -ExpandProperty IPAddress)[1]; $env:MINIO_PORT = 9010;
If you are encountering issues with attachments in the web client, it suggests that an error occurred in the first variable. To resolve this, you can simply update the code segment with the private IP address of your machine.
Now you can access apps at the following addresses:
Run migrations:
docker-compose exec sama-server sh -c "MONGODB_URL=mongodb://172.25.0.4/samatests npm run migrate-mongo-up"
Run e2e tests:
docker-compose exec sama-server sh -c "MONGODB_URL=mongodb://172.25.0.4/samatests npm run test"
The whole SAMA stack can be tested using https://app.samacloud.io public cloud.
Also, there is a set of detailed articles for each API:
Any thoughts, feedback is welcome! Please create a GitHub issue for any feedback you have.
Want to support us with some coffee?. Will be much appreciated!