SMSGate Server

Once the services are running, you can access the application via HTTPS using the domain you configured in the DOMAIN environment variable.

Example: https://sms.example.com

Before deploying SMSGate using the Docker Compose single-file method, ensure your environment meets these requirements:

• Docker Compose: version 2.23.1 or later.
• Portainer (optional): version 2.20.0 or later if using it for management.
• Network: Your server must have a public IP address.
• DNS: A domain name must be configured to point to your server's public IP address.

Create a .env file in the root directory of your project to define essential credentials and network settings. Replace all [placeholder] values with your actual sensitive data.

MYSQL_ROOT_PASSWORD=[your_root_password]
MYSQL_PASSWORD=[your_mysql_password]
DOMAIN=sms.example.com
ACME_EMAIL=email@example.com
GATEWAY_PRIVATE_TOKEN=[your_private_token]

To start the SMSGate services in detached mode (running in the background), execute the following command from the directory containing your Docker Compose file:

docker-compose up -d

To remove the deployment, delete the Helm release using its release name.

helm delete my-release

Configuration is primarily managed through a YAML file (e.g., configs/config.yml). Every configuration key can be overridden using environment variables following the pattern SECTION__KEY (using double underscores).

Key Sections:

• database
• gateway
• http
• fcm
• sse
• messages
• cache
• pubsub
• jwt
• otp
• tasks

To run in private mode, you must set gateway.mode: private and provide a gateway.private_token in your configuration.

export GATEWAY__MODE=private
export GATEWAY__PRIVATE_TOKEN=change-me
export DATABASE__HOST=localhost
export HTTP__LISTEN=0.0.0.0:3000

Deploy the SMSGate Server to a Kubernetes cluster using Helm. Ensure you have Kubernetes 1.23+, Helm 3.2.0+, and PV provisioner support if using persistent storage for the database.

helm repo add sms-gate https://s3.sms-gate.app/charts
helm repo update
helm install my-release sms-gate/server

To connect to an external MySQL 8.0.13+ or MariaDB 10.2.7+ instance, set database.deployInternal to false and provide the connection details.

database:
  deployInternal: false
  host: external-db-host
  port: 3306
  user: external-user
  password: "secure-password"
  name: external-db

Adjust the CPU and memory resources allocated to the server containers.

resources:
  limits:
    cpu: 1000m
    memory: 1Gi
  requests:
    cpu: 200m
    memory: 256Mi

The sms-gateway-proxy deployment consists of four main components working together:

1. reproxy: A reverse proxy service (umputun/reproxy) that handles incoming traffic on ports 80 and 443. It manages SSL certificates automatically via ACME and routes traffic to the backend.
2. backend: The primary SMSGate server service (ghcr.io/android-sms-gateway/server:latest) that handles HTTP requests.
3. worker: A secondary instance of the server service running in worker mode (/app/app worker). This is used for background processing tasks.
4. db: A MariaDB container (mariadb:lts) providing persistent storage for the application data.

Service Dependencies:

• The backend and worker services depend on the db service being healthy before they start.
• The backend and worker services share the same config.yml configuration provided via Docker configs.

You can provide configuration to the gateway in two ways by setting gateway.config.enabled: true:

1. Using an existing ConfigMap: Reference a pre-existing Kubernetes ConfigMap via gateway.config.existingConfigMap.
2. Using inline YAML: Provide the configuration content directly via gateway.config.data.

### Using an Existing ConfigMap
```yaml
gateway:
  config:
    enabled: true
    existingConfigMap: my-existing-configmap

Using Inline YAML Configuration

gateway:
  config:
    enabled: true
    data: |
      tasks:
        hashing:
          interval_seconds: 900