Docker Self-hosted installation

[mmojadad]

Hello
Since MySQL was already installed on my machine for another purpose, and port 3000 was also occupied,
I tried to run a containerized version of MySQL and also run SMS Gateway for Android on port 3001. Additionally, I'm using Nginx as a reverse proxy for my desired domain.
The result I got is that the project successfully runs on my domain without any errors, but all I see is a black page that says "Not Found".
I would be really grateful if you could help me solve this issue.
I'm using exactly the following two files: config.yml and docker-compose.yml [as shown below].

-----------config.yml ---------

gateway:
  mode: private
  private_token: 431539910

http:
  listen: 0.0.0.0:3001
  proxies:
    - "127.0.0.1"
  api:
    host:
    path: /api
  openapi:
    enabled: false

fcm:
  credentials_json: "{}"
  timeout_seconds: 1
  debounce_seconds: 5

sse:
  keep_alive_period_seconds: 15

messages:
  cache_ttl_seconds: 300
  hashing_interval_seconds: 60

cache:
  url: memory://

pubsub:
  url: memory://

## Worker Config ##
tasks:
  messages_hashing:
    interval: 168h
  messages_cleanup:
    interval: 24h
    max_age: 720h
  devices_cleanup:
    interval: 24h
    max_age: 8760h

database:
  host: mysql
  port: 3306
  user: smsgateway
  password: he8rlcobltro
  database: sms
  timezone: Asia/Tehran
  debug: false
  max_open_conns: 10
  max_idle_conns: 5

logging:
  level: info

---

------------- docker-compose.yml ----------

version: '3.9'

services:
  mysql:
    image: mysql:8.0
    container_name: sms-gateway-mysql
    restart: unless-stopped
    environment:
      MYSQL_ROOT_PASSWORD: fuyltratith3
      MYSQL_DATABASE: sms
      MYSQL_USER: smsgateway
      MYSQL_PASSWORD: he8rlcobltro
    ports:
      - "3307:3306"
    volumes:
      - mysql-data:/var/lib/mysql
    command: --default-authentication-plugin=mysql_native_password
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "root", "-p$$MYSQL_ROOT_PASSWORD"]
      interval: 5s
      timeout: 5s
      retries: 20
      start_period: 10s

  app:
    image: ghcr.io/android-sms-gateway/server:latest
    container_name: sms-gateway-app
    restart: unless-stopped
    depends_on:
      mysql:
        condition: service_healthy
    ports:
      - "3001:3001"
    volumes:
      - ./config.yml:/app/config.yml:ro
    environment:
      - CONFIG_PATH=/app/config.yml
    healthcheck:
      test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost:3001/health"]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 15s

volumes:
  mysql-data:

---

[capcom6]

Hi!

The server's root path is empty by design, so a 404 error is ok here.

If you haven't configured path rewriting in nginx, try entering the paths /health and /api/3rdparty/v1/health in your browser or using curl to check the server's availability.

[mmojadad]

Thank you for your guidance.
Here’s the current status:
----------- https://mydomain.com/api/3rdparty/v1/health ---------

status | "pass"
version | "v1.34.1"
releaseId | 1246
description | "Database ping"
observedUnit | "failed pings"
observedValue | 0
status | "pass"

---

----------https://mydomain.com/3rdparty/v1/messages ------
Not Found

In mobile App side, Everything seems ok, Registraation happen and get Username,Password, Device ID.

----- Nginx Proxy Manager -------

---

However, the following issues still exist:
For sending SMS, I’m using this template:

curl -X POST -u 6LQBH2:9dkkz0zk162_8s \
    -H "Content-Type: application/json" \
    -d '{ "textMessage": { "text": "Hello, world!"}, "phoneNumbers": ["+1343243423"] }' \
    https://mydomain.com/3rdparty/v1/messages

---

CMD : Not Found

[capcom6]

You've missed the /api part in the path. The full URL should be https://mydomain.com/api/3rdparty/v1/messages

[mmojadad]

You've missed the /api part in the path. The full URL should be https://mydomain.com/api/3rdparty/v1/messages

Thank you for your guidance!
With this fix, the SMS is now being sent successfully. 😊

[mmojadad]

What will be SMSGate API Doc path ?

[capcom6]

According to the config, provided in the first message, OpenAPI doc is disabled. To enable it, change the value of http.openapi.enabled to true:

http:
  openapi:
    enabled: true

After this, the API docs will be available at https://mydomain.com/api/

[mmojadad]

Hello
I reopened this thread because I encountered a problem.
Using the same config.yml and docker-compose.yml, I performed the installation on another machine.
The sms-gateway-mysql container is running successfully, but the sms-gateway-app container remains in an unhealthy status, and no matter how much I tried, I couldn’t find a solution to the problem.
I would appreciate it if you could guide me.
The error log of the container is as follows:

failed to create modcache index dir: mkdir /dev/null: not a directory
goose: no migrations to run. current version: 20251121071748

I’m attaching the full log.

full-log.txt

[capcom6]

Hello!

According to the logs, you changed the server port from 3000 to 3001, but the health check uses 3000 by default. This is why the health check fails.

Change the server port back to 3000 or override the health check command when starting the container.

[github-actions]

This issue is stale because it has been open for 7 days with no activity.

[github-actions]

This issue was closed because it has been inactive for 7 days since being marked as stale.