Docker Server Setup

1.   / 
2. Overview   / 
3. Docker Server Setup

---

Local Development

1. Make sure you have latest Node 18 installed.

2. Copy .env.example to .env.

3. run dependant services (MongoDB, Minio, Redis) via

   docker-compose -f docker-compose.yml -f docker-compose.development.yml up

4. npm install

5. npm run migrate-mongo-up

6. npm run start

   Tip

   In a case of running under Windows - see https://github.com/SAMA-Communications/sama-server/issues/128

7. Now the server will be listening for incoming connections at ws://localhost:9001

Compete Deployment

Deploying the SAMA application can be done easily with Docker, whether you want a complete setup with all dependencies or a local environment with the main applications. Below are the steps to follow:

Docker one-command deployment

This approach builds and runs the entire SAMA application, including all dependencies, in a single command. It is ideal for setting up the full environment quickly.

To deploy using this method, run:

docker-compose -f docker-compose-full.yml up --build

Docker local deployment

To run the dependency services along with the main SAMA applications (sama-client, sama-server, and sama-push-daemon), use:

docker-compose up --build

Warning

If you are using MacOS or Windows, and want run SAMA apps, add these two variables before the launch command:

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;

MacOS

MINIO_ENDPOINT=$(ipconfig getifaddr en0) MINIO_PORT=9010

Note

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.

Avaible Links

Now you can access apps at the following addresses:

Server-API http://localhost:9000

Web-Client http://localhost:10000

Minio-API http://localhost:9010

Minio-Client http://localhost:9011

Push-dashboard http://localhost:3001/ui

Server-dashboard http://localhost:9002

Redis-commander http://localhost:8081

Docker e2e tests & migrations

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"

Useful Link

SAMA: chat server tech stack In the world of real-time communication, chat servers play a vital role in connecting people across various platforms. To build a robust and scalable chat server, selecting the right technology stack is crucial.