Add documentation

Author: forasoft

README.md

@@ -1,2 +1,33 @@
 # intercom-sip-server
 An open example implementing a SIP server for an intercom
+
+# Deploy server
+
+To deploy project, create file `deploy/.env` from example, adjust settings and use `deploy.sh` from the project root.
+
+Following ports should be accessible on server:
+ - 80 (for HTTP)
+ - 5060 (for SIP)
+ - 16000-16999 (for RTP media)
+
+# Run frontend
+
+After deploy, frontend and SIP over WebSocket will be on HTTP port 80 on the server. It's preferred to set up proxy with HTTPS in front of it.
+The client app should navigate to `https://{PROXY_URL}/?user={USER_NUMBER}&password={USER_PASSWORD}&domain={EXTERNAL_IP}&url={WS_ENDPOINT}`.
+
+External IP could be acquired by running command `docker exec -it doma-freeswitch-1 /usr/local/freeswitch/bin/fs_cli -x 'sofia status profile internal'` on deployed server in field `Ext-RTP-IP`.
+
+For example, if your server is deployed on IP `192.168.10.42` and is behind proxy on `https://sip.example.com/`
+
+    user = 1000
+    password = 1234
+    domain = 192.168.10.42
+    url = wss://sip.example.com/sip (Note wss instead of https)
+
+All url parameters should be url-encoded.
+
+# Users import script
+
+Prepare `.csv` file with pairs of `number,password` of users, and run `cd scripts && node importUsers.js /path/to/users.csv`. This script will import users in running instance of the server. 
+
+Note: if container was rebuilt, it's required to import users again.

deploy/.env.example

@@ -0,0 +1 @@
+SIP_SERVER_IP=192.168.10.42

deploy/docker-compose.yml

@@ -5,8 +5,6 @@ services:
     build:
       context: ../services/freeswitch
       dockerfile: ./Dockerfile
-      args:
-        - SIP_PASSWORD
     network_mode: host
     restart: always
 
@@ -15,10 +13,8 @@ services:
       context: ../services/frontend
       dockerfile: ./Dockerfile
       args:
-        - VITE_SIP_SERVER_IP
-        - VITE_SIP_SERVER_URL
-        - SERVER_IP
+        - SIP_SERVER_IP
     network_mode: host
     env_file:
-      - ../services/frontend/.env
+      - .env
     restart: always

services/frontend/Dockerfile

@@ -9,18 +9,14 @@ COPY package.json package-lock.json ./
 RUN npm ci
 COPY . /app
 
-ARG VITE_SIP_SERVER_IP
-ARG VITE_SIP_SERVER_URL
+ARG SIP_SERVER_IP
 
-ENV VITE_SIP_SERVER_IP=$VITE_SIP_SERVER_IP
-ENV VITE_SIP_SERVER_URL=$VITE_SIP_SERVER_URL
-
-# RUN printenv >> .env
+ENV SIP_SERVER_IP=$SIP_SERVER_IP
 
 RUN npm run build
 RUN rm -rf ./node_modules
 
 COPY nginx.conf /etc/nginx/conf.d/default.conf
-RUN sed -i -E "s/SERVER_IP/$VITE_SIP_SERVER_IP/" /etc/nginx/conf.d/default.conf
+RUN sed -i -E "s/SERVER_IP/$SIP_SERVER_IP/" /etc/nginx/conf.d/default.conf
 
 EXPOSE 80