Error Generating Database When Trying To Setup Shlink

[MatthewGerges]

How Shlink is set up

• Shlink Version: 3.6.3
• PHP Version: 8.1.2
• How do you serve Shlink: I tried installing it via the docker image and I tried installing it using the dist file that comes in the latest distributable.
• Database engine used: MySQL

Summary

As described above, I tried installing shlink via docker (from the install docker page: https://shlink.io/documentation/install-docker-image/ ). I was able to successfully generate an API key. All the commands worked well until I got to the step titled "use an external db" As you can see I pasted the command below:

Please note that I tried using both a MySQL database I created on my Microsoft Azure account and I tried using a local one as well (and when I go to a separate terminal and type mysql -u root -p it works just fine - it doesn't give me any error outputs - it simply tells me welcome to the mysql monitor or to the mariadb monitor:

Regardless if I chose to run it with mysql or mariadb - online or locally - I still got the error:

         error info.```
P.S. if you look at what I have ran above, I entered the -vvv argument and it didn't give me any additional context. Also, please note that the online database I created does not have any data in it (same thing with the local MySQL and mariadb ones). I also checked MySQL workbench which told me my SQL connection is running on localhost: 3306. 

I also tried going a different route and running the command to run the custom installer file but after all of that, I still got the error:
```[ERROR] Error generating database.. Run this command with -vvv to see specific
         error info.```
I don't know how to proceed.

I don't know if it matters but after I ran the very first command in the getting started documentation:

docker run
--name my_shlink
-p 8080:8080
-e DEFAULT_DOMAIN=s.test
-e IS_HTTPS_ENABLED=true
-e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345
shlinkio/shlink:stable
```
AND:

docker exec -it my_shlink shlink api-key:generate

I had to delete the docker container with the name my_shlink because when I was running the next command:

docker run \
    --name my_shlink \
    -p 8080:8080 \
    -e DEFAULT_DOMAIN=s.test \
    -e IS_HTTPS_ENABLED=true \
    -e GEOLITE_LICENSE_KEY=kjh23ljkbndskj345 \
    -e DB_DRIVER=mysql \
    -e DB_USER=root \
    -e DB_PASSWORD=123abc \
    -e DB_HOST=something.rds.amazonaws.com \
    shlinkio/shlink:stable

It gave me the error:

docker: Error response from daemon: Conflict. The container name "/my_shlink" is already in use by container "e01534b28cfd7eb1fd3a6286a3a459be7120a36aa0d044866adc1eec622b229a". You have to remove (or rename) that container to be able to reuse that name.
See 'docker run --help'.

So I just decided to delete that container and move on to the next command

For context, all I'm trying to do is to find a free or cheap way to create QR codes with links (I don't care about custom domain names) and then I want to use a rest API to change the original URL that that QR code would link to without changing the shlink URL. If there is another way to do this (with another tool - preferably with CORS) or a simpler way to go through the installation, please do let me know! THANK YOU!

Current behavior

I'm getting the error: [ERROR] Error generating database.. Run this command with -vvv to see specific error info.

Expected behavior

I should not be getting the above error but should be able to proceed to hosting the docker image or whatever the local installation file builds (does the local dist installation file also create a docker image)?

How to reproduce

You can try going through the same installation steps I went through on a Windows 11 machine - where I installed Ubuntu 22.04 lts and Docker and just ran the above commands

[acelaya]

PHP 8.1.2 has a bug. Other people have reported issues running Shlink with that version and the only solution is to update to a newer one. See #1722

That said, the docker image is using a different PHP version, so you should not get affected by that.

Try passing SHELL_VERBOSITY=3 to the docker container. It's equivalent to -vvv for when you are not the one running the command https://shlink.io/documentation/troubleshooting/#troubleshoot-errors-when-booting-up-the-docker-image

[MatthewGerges]

Ok great, thank you so much! I ended up passing -e SHELL_VERBOSITY=3 to the docker image I wanted to build and I found out that I had the error because my azure MySQL database required an SSL certificate so I removed the need for that online and it worked. This is the command I ran

However, whenever I visit localhost:8081, I get an error message saying 404 page not found.

Am I missing something here, I just want to access the web client after running the docker image (also the error on my dist installation tool is still giving me the same error in database creation but I'm not going to use that tool). I thought I would be able to access the web client locally on localhost:8080 or 8081 but apparently that doesn't work

I can try using the web client that is freely hosted by shlink: https://app.shlink.io/server/create but I believe I would need to host my docker image to a server, correct? Otherwise, what would I put as the URL?

Essentially, all I would like to do is to create a REST API that changes the URL destination of QR codes I generate. Unfortunately, to me the documentation is a bit unclear as to how I can get the REST API running. What are my next steps? I'm confused do I need to serve the docker image to access the rest API and to serve the docker image, do I need to do something with road runner (which would confuse me even more because running the docker image creates a roadrunner server anyways). Again, your help would be greatly appreciated!

P.S. this is the output I get when I run the docker image and it successful:

Initializing database if needed... [Running "/usr/local/bin/php bin/cli db:create"]   RUN  '/usr/local/bin/php' 'bin/cli' 'db:create'
^[[B  OUT
  OUT   [OK] Database already exists. Run "db:migrate" command to make sure it is up to
  OUT        date.

  OUT
  OUT
  RES  Command ran successfully
 Success!
Updating database... [Running "/usr/local/bin/php bin/cli db:migrate"]   RUN  '/usr/local/bin/php' 'bin/cli' 'db:migrate'
  OUT  Migrating database...
  OUT
  ERR    RUN  '/usr/local/bin/php' 'vendor/doctrine/migrations/bin/doctrine-migrations.php' 'migrations:migrate' '--no-interaction'
  ERR    OUT
  ERR    OUT   [OK] Successfully migrated to version : ShlinkMigrations\Version20230303164233
  ERR    OUT
  ERR    OUT
  ERR    OUT
  ERR    RES  Command ran successfully
  ERR
  OUT
  OUT   [OK] Database properly migrated!

  OUT
  OUT
  RES  Command ran successfully
 Success!
Generating proxies... [Running "/usr/local/bin/php bin/doctrine orm:generate-proxies"]   RUN  '/usr/local/bin/php' 'bin/doctrine' 'orm:generate-proxies'
  ERR   Processing entity "Shlinkio\Shlink\Core\Visit\Entity\VisitLocation"
  ERR   Processing entity "Shlinkio\Shlink\Core\Visit\Entity\Visit"
  ERR   Processing entity "Shlinkio\Shlink\Core\Tag\Entity\Tag"
  ERR   Processing entity "Shlinkio\Shlink\Core\ShortUrl\Entity\DeviceLongUrl"
  ERR   Processing entity "Shlinkio\Shlink\Core\Domain\Entity\Domain"
  ERR   Processing entity "Shlinkio\Shlink\Core\ShortUrl\Entity\ShortUrl"
  ERR   Processing entity "Shlinkio\Shlink\Rest\Entity\ApiKey"
  ERR   Processing entity "Shlinkio\Shlink\Rest\Entity\ApiKeyRole"
  ERR
  ERR   Proxy classes generated to "/etc/shlink/data/proxies"
  ERR
  RES  Command ran successfully
 Success!
Clearing entities cache... [Running "/usr/local/bin/php bin/doctrine orm:clear-cache:metadata"]   RUN  '/usr/local/bin/php' 'bin/doctrine' 'orm:clear-cache:metadata'
  ERR
  ERR   // Clearing all Metadata cache entries

  ERR
  ERR   [OK] Successfully deleted cache entries.

  ERR
  ERR
  RES  Command ran successfully
 Success!
Downloading GeoLite2 db file... [Running "/usr/local/bin/php bin/cli visit:download-db"]   RUN  '/usr/local/bin/php' 'bin/cli' 'visit:download-db'
  OUT   Downloading GeoLite2 db file...
  OUT      0 [>---------------------------] < 1 sec 12.0 MiB    0 [->--------------------------] < 1 sec 12.0 MiB    0 [--->------------------------] < 1 sec 12.0 MiB    0 [----->----------------------] < 1 sec 12.0 MiB    0 [------->--------------------] < 1 sec 12.0 MiB    0 [--------->------------------] < 1 sec 12.0 MiB    0 [----------->----------------] < 1 sec 12.0 MiB    0 [------------->--------------] < 1 sec 12.0 MiB    0 [-------------->-------------] < 1 sec 12.0 MiB    0 [---------------->-----------] < 1 sec 12.0 MiB    0 [------------------>---------] < 1 sec 12.0 MiB    0 [-------------------->-------] < 1 sec 12.0 MiB    0 [---------------------->-----] < 1 sec 12.0 MiB    0 [------------------------>---] < 1 sec 12.0 MiB    0 [-------------------------->-] < 1 sec 12.0 MiB    0 [>---------------------------] < 1 sec 12.0 MiB    0 [->--------------------------] < 1 sec 12.0 MiB    0 [--->------------------------] < 1 sec 12.0 MiB    0 [----->----------------------] < 1 sec 12.0 MiB    0 [------->--------------------] < 1 sec 12.0 MiB    0 [--------->------------------] < 1 sec 12.0 MiB    0 [----------->----------------] < 1 sec 12.0 MiB    0 [------------->--------------] < 1 sec 12.0 MiB    0 [-------------->-------------] < 1 sec 12.0 MiB    0 [---------------->-----------] < 1 sec 12.0 MiB    0 [------------------>---------] < 1 sec 12.0 MiB    0 [-------------------->-------] < 1 sec 12.0 MiB    0 [---------------------->-----] < 1 sec 12.0 MiB    0 [------------------------>---] < 1 sec 12.0 MiB    0 [-------------------------->-] < 1 sec 12.0 MiB    0 [>---------------------------] < 1 sec 12.0 MiB
  OUT    3489792/34821699 [==>-------------------------]  10% < 1 sec/< 1 sec 12.0 MiB
  OUT    6967296/34821699 [=====>----------------------]  20%  1 sec/5 secs 12.0 MiB
  OUT   10477568/34821699 [========>-------------------]  30%  1 sec/3 secs 12.0 MiB
  OUT   13971456/34821699 [===========>----------------]  40%  1 sec/2 secs 12.0 MiB
  OUT   17424384/34821699 [==============>-------------]  50%  1 sec/2 secs 12.0 MiB
  OUT   20901888/34821699 [================>-----------]  60%  1 sec/2 secs 12.0 MiB
  OUT   24379392/34821699 [===================>--------]  70% 2 secs/3 secs 12.0 MiB
  OUT   27860992/34821699 [======================>-----]  80% 2 secs/2 secs 12.0 MiB
  OUT   31342592/34821699 [=========================>--]  90% 2 secs/2 secs 12.0 MiB
  OUT   34821699/34821699 [============================] 100% 2 secs/2 secs 12.0 MiB
  OUT
  OUT   [OK] GeoLite2 db file properly downloaded.

  OUT
  OUT
  RES  Command ran successfully
 Success!
{"level":"debug","ts":1690342817978371245,"logger":"rpc","msg":"plugin was started","address":"tcp://127.0.0.1:6001","list of the plugins with RPC methods:":["jobs","lock","resetter","informer","app"]}
{"level":"debug","ts":1690342817978778571,"logger":"jobs","msg":"driver ready","pipeline":"shlink","driver":"memory","start":1690342817978669380,"elapsed":0.000108207}
{"level":"debug","ts":1690342817978886590,"logger":"memory","msg":"pipeline was started","driver":"memory","pipeline":"shlink","start":"2023-07-26 03:40:17.97888058 +0000 UTC","elapsed":"27.786µs"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 38, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 41, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 40, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 43, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 39, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 42, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 44, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 45, "internal_event_name": "EventWorkerConstruct"}
[INFO] RoadRunner server started; version: 2023.1.5, buildtime: 2023-06-08T14:45:05+0000
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 53, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 58, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 59, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 60, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 62, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 56, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 57, "internal_event_name": "EventWorkerConstruct"}
2023-07-26T03:40:18+0000        DEBUG   server          worker is allocated   {"pid": 61, "internal_event_name": "EventWorkerConstruct"}
{"level":"debug","ts":1690342837333116459,"logger":"jobs","msg":"job was pushed successfully","ID":"ce44125a-4f63-4005-9684-9d2e8c4908a4","pipeline":"shlink","driver":"memory","start":1690342837333059081,"elapsed":0.000055717}
{"level":"debug","ts":1690342837333401147,"logger":"memory","msg":"message pushed to the priority queue","current":1,"limit":10}
{"level":"debug","ts":1690342837333482941,"logger":"jobs","msg":"job processing was started","ID":"ce44125a-4f63-4005-9684-9d2e8c4908a4","start":1690342818175246959,"elapsed":19.158233617}
{"level":"debug","ts":1690342837333821577,"logger":"jobs","msg":"job was pushed successfully","ID":"9868d7e3-9c09-4bee-9a3a-3c4de1fc8c93","pipeline":"shlink","driver":"memory","start":1690342837333788053,"elapsed":0.000032804}
{"level":"debug","ts":1690342837333905825,"logger":"memory","msg":"message pushed to the priority queue","current":2,"limit":10}
{"level":"debug","ts":1690342837333939866,"logger":"jobs","msg":"job processing was started","ID":"9868d7e3-9c09-4bee-9a3a-3c4de1fc8c93","start":1690342818175375090,"elapsed":19.15856204}
{"level":"debug","ts":1690342837334271724,"logger":"jobs","msg":"job was pushed successfully","ID":"b9f3b206-936a-44a0-a7ea-cf6d74612b98","pipeline":"shlink","driver":"memory","start":1690342837334213442,"elapsed":0.000057128}
{"level":"debug","ts":1690342837334384792,"logger":"memory","msg":"message pushed to the priority queue","current":3,"limit":10}
{"level":"debug","ts":1690342837334431794,"logger":"jobs","msg":"job processing was started","ID":"b9f3b206-936a-44a0-a7ea-cf6d74612b98","start":1690342818175418486,"elapsed":19.159012862}
{"level":"debug","ts":1690342837334673092,"logger":"jobs","msg":"job was pushed successfully","ID":"62261688-a447-43e4-894a-e9e55f5c52ff","pipeline":"shlink","driver":"memory","start":1690342837334620092,"elapsed":0.000052202}
{"level":"debug","ts":1690342837334758252,"logger":"memory","msg":"message pushed to the priority queue","current":4,"limit":10}
{"level":"debug","ts":1690342837334776596,"logger":"jobs","msg":"job processing was started","ID":"62261688-a447-43e4-894a-e9e55f5c52ff","start":1690342818175420692,"elapsed":19.159355607}
{"level":"debug","ts":1690342837335111176,"logger":"jobs","msg":"job was pushed successfully","ID":"d139323f-26f4-48f3-8bff-d8cbdc5d5960","pipeline":"shlink","driver":"memory","start":1690342837335058766,"elapsed":0.00005177}
{"level":"debug","ts":1690342837335200763,"logger":"memory","msg":"message pushed to the priority queue","current":5,"limit":10}
{"level":"debug","ts":1690342837335237726,"logger":"jobs","msg":"job processing was started","ID":"d139323f-26f4-48f3-8bff-d8cbdc5d5960","start":1690342818175482580,"elapsed":19.159754689}
{"level":"debug","ts":1690342837354657583,"logger":"jobs","msg":"job was processed successfully","ID":"b9f3b206-936a-44a0-a7ea-cf6d74612b98","start":1690342818175418486,"elapsed":19.179235735}
{"level":"debug","ts":1690342837364600872,"logger":"jobs","msg":"job was processed successfully","ID":"62261688-a447-43e4-894a-e9e55f5c52ff","start":1690342818175420692,"elapsed":19.18917608}
{"level":"debug","ts":1690342837364880132,"logger":"jobs","msg":"job was processed successfully","ID":"d139323f-26f4-48f3-8bff-d8cbdc5d5960","start":1690342818175482580,"elapsed":19.189395737}
{"level":"debug","ts":1690342837376297083,"logger":"jobs","msg":"job was processed successfully","ID":"9868d7e3-9c09-4bee-9a3a-3c4de1fc8c93","start":1690342818175375090,"elapsed":19.200919158}
2023-07-26T03:40:37+0000        INFO    server          [2023-07-26T03:40:37.383414+00:00] [69401e7a-5958-4664-8492-61331eb1bae0] Access.INFO - GET / 404 979
{"level":"debug","ts":1690342837593643694,"logger":"jobs","msg":"job was processed successfully","ID":"ce44125a-4f63-4005-9684-9d2e8c4908a4","start":1690342818175246959,"elapsed":19.418393453}

The last part is what I get when I load the localhost:8080 or localhost:8081 which shows that it was "processed successfully" even though the web page is giving me a 404 error:

{"level":"debug","ts":1690343281015791435,"logger":"jobs","msg":"job was processed successfully","ID":"69fe661b-53e9-4803-a167-67a86ca02435","start":1690342818175512900,"elapsed":462.84027504}
2023-07-26T03:48:01+0000        INFO    server          [2023-07-26T03:48:01.034011+00:00] [1ffeb5bf-c1d2-49ff-93d0-7ef9af6e1305] Access.INFO - GET / 404 979
{"level":"debug","ts":1690343281228279569,"logger":"jobs","msg":"job was processed successfully","ID":"0d7bcccc-7a92-4981-ade8-3d0b0fde1b4e","start":1690342818175488600,"elapsed":463.052787393}

[acelaya]

Getting a 404 on the base path is expected. You can alternatively configure a redirect, but the 404 is the default behavior.

Shlink does not include a UI. You can either interact with it with the CLI, use the official web client (https://app.shlink.io or self-hosted) or use any other unofficial client.