SQLSTATE[HY000] [2002] Connection refused error when running Shlink CLI

[Rol-a]

Shlink version

4

PHP version

8

How do you serve Shlink

Docker image

Database engine

MariaDB

Database version

10.8

Summary

Hello everyone!
Thank you very much for everything you do here.
I recently attempted to create a shlink server but run into some issue. I am convinced I am doing something and would love some insight please. After creating the docker-compose.yml file and running it, everything seems to be working for what I am seeing. However when I attempted to generate the api key it gives me an error.and for some reason the server becomes very slow.
Here is the command along with the error message:

sudo docker exec shlink-backend shlink api-key:generate


In ServiceManager.php line 649:
                                                                               
  Service with name "Shlinkio\Shlink\Rest\ApiKey\Repository\ApiKeyRepository"  
   could not be created. Reason: An exception occurred in the driver: SQLSTAT  
  E[HY000] [2002] Connection refused                                           
                                                                               

In ExceptionConverter.php line 80:
                                                                               
  An exception occurred in the driver: SQLSTATE[HY000] [2002] Connection refu  
  sed                                                                          
                                                                               

In Exception.php line 24:
                                             
  SQLSTATE[HY000] [2002] Connection refused  
                                             

In PDOConnect.php line 25:
                                             
  SQLSTATE[HY000] [2002] Connection refused  
                                             

exit status 255

[acelaya]

This doesn't seem to be related with API keys specifically, but rather a misconfiguration that is preventing Shlink from connecting to the database.

Can you share your docker-compose file and provide some steps to reproduce it?

[acelaya]

@Rol-a I have deleted your comment, because it had what seemed to be your database password and GeoLite license key.

This is your original comment with a few parts redacted:

Ok, that's interesting. Yes, I can share. This was on Ubuntu 24.04 by the way. Thank you.

sudo mkdir -p /opt/shlink/db/
sudo vim /opt/shlink/docker-compose.yml

docker-compose.yml

services:
  shlink:
    image: shlinkio/shlink:stable
    restart: always
    container_name: shlink-backend
    environment:
      - TZ="America/Los_Angeles"
      - DEFAULT_DOMAIN=********
      - IS_HTTPS_ENABLED=false
      - GEOLITE_LICENSE_KEY=******** 
      - DB_DRIVER=maria
      - DB_USER=********
      - DB_NAME=zdb
      - DB_PASSWORD=********
      - DB_HOST=database
    depends_on:
      - database
    ports:
      - 8080

  database:
    image: mariadb:10.8
    restart: always
    container_name: shlink-database
    environment:
      - MARIADB_ROOT_PASSWORD=********
      - MARIADB_DATABASE=zdb
      - MARIADB_USER=********
      - MARIADB_PASSWORD=********
    volumes:
      - /opt/shlink/db:/var/lib/mysql

  shlink-web-client:
    image: shlinkio/shlink-web-client
    restart: always
    container_name: shlink-gui
    depends_on:
      - shlink
    ports:
      - 8180:8080

cd /opt/shlink

sudo docker compose up -d
    
sudo docker exec shlink-backend shlink api-key:generate

I would recommend you to disable that license key and create a new one, as it has been out in the open for almost an hour.

[acelaya]

@Rol-a the problem is that you forgot to link the Shlink and the database containers:

services:
  shlink:
    image: shlinkio/shlink:stable
    restart: always
    container_name: shlink-backend
    depends_on:
      - database
+   links:
+     - database
     # ...

  database:
     # ...

  shlink-web-client:
     # ...

With that it works.

[Rol-a]

Thank you very much for your help. I was able to generate the key, but unfortunately I was not able to create the server because the url was throwing an error. So I went back into the compose file and updated IS_HTTPS_ENABLED from false to true. And when I tried to generate the key I received this error.

In ExceptionConverter.php line 40:
                                                                               
  An exception occurred while executing a query: SQLSTATE[42S02]: Base table   
  or view not found: 1146 Table 'zdb.api_keys' doesn't exist                 
                                                                               

In Exception.php line 24:
                                                                               
  SQLSTATE[42S02]: Base table or view not found: 1146 Table 'zdb.api_keys'   
  doesn't exist                                                                
                                                                               

In Statement.php line 55:
                                                                               
  SQLSTATE[42S02]: Base table or view not found: 1146 Table 'zdb.api_keys'   
  doesn't exist                                                                
                                                                               

api-key:generate [-m|--name NAME] [-e|--expiration-date EXPIRATION-DATE] [-a|--author-only] [-d|--domain-only DOMAIN-ONLY] [-o|--no-orphan-visits]

exit status 255