container doesn't start if DB_HOST not set in docker-compose.yml

[joergr]

Plattform: x64, Arch Linux, Docker 18.09.6-ce

When I don't provide any SQL-settings in docker-compose.yml as suggested here https://github.com/linuxserver/docker-bookstack#advanced-users-full-control-over-the-env-file the container doesn't come up.

bookstack    | [cont-init.d] 10-adduser: exited 0.
bookstack    | [cont-init.d] 20-config: executing...
bookstack    | [cont-init.d] 20-config: exited 0.
bookstack    | [cont-init.d] 30-keygen: executing...
bookstack    | using keys found in /config/keys
bookstack    | [cont-init.d] 30-keygen: exited 0.
bookstack    | [cont-init.d] 50-config: executing...
bookstack    | App Key found - setting variable for seds
bookstack    | usage: nc [-46CDdFhklNnrStUuvZz] [-I length] [-i interval] [-O length]
bookstack    | 	  [-P proxy_username] [-p source_port] [-q seconds] [-s source]
bookstack    | 	  [-T toskeyword] [-V rtable] [-w timeout] [-X proxy_protocol]
bookstack    | 	  [-x proxy_address[:port]] [destination] [port]
bookstack    | usage: nc [-46CDdFhklNnrStUuvZz] [-I length] [-i interval] [-O length]
bookstack    | 	  [-P proxy_username] [-p source_port] [-q seconds] [-s source]
bookstack    | 	  [-T toskeyword] [-V rtable] [-w timeout] [-X proxy_protocol]
bookstack    | 	  [-x proxy_address[:port]] [destination] [port]

and so on ... until I press control-c

The minimum environment variable I have to provide ist DB_HOST.

By the way:
Even if I set DB_HOST in docker-compose.yml the container comes up with a warning:

bookstack    | [cont-init.d] 50-config: executing...
bookstack    | App Key found - setting variable for seds
bookstack    | /var/run/s6/etc/cont-init.d/50-config: line 62: warning: command substitution: ignored null byte in input
bookstack    | /var/run/s6/etc/cont-init.d/50-config: line 62: warning: command substitution: ignored null byte in input
bookstack    | Nothing to migrate.
bookstack    | [cont-init.d] 50-config: exited 0.

Not sure, if that is an error in the container or a missleading information in the README.

docker-compose.yml
To reproduce the error I commented DB-HOST. If I uncomment the line everything runs fine.

version: '3'
services:
    bookstack:
        image: linuxserver/bookstack
        container_name: bookstack
        hostname: mimir
        restart: always
        environment:
            - PUID=1000
            - PGID=1000
            # - DB_HOST=mariadb
        networks:
            - web
            - dcnetwork
        expose:
            - 80
        volumes:
            - ./config:/config
        labels:
            - "traefik.enable=true"
        ...

And the relevant part from .env

APP_URL=https://mimir.xxx.xxx

# Database details
DB_HOST=mariadb
DB_DATABASE=xxx
DB_USERNAME=xxx
DB_PASSWORD=xxx

[CHBMB]

Have you configured the .env file?

Otherwise I don't see how without a valid config provided either through compose/docker run variables or configuration via a valid .env the application can be expected to start.

[joergr]

I documented the .env file at the end of the issue. Of course, the 'xxx' is for privacy.
The .env file works because otherwise the container won't start.
The only difference: I can provide anything but DB_HOST in the .env file. Only DB_HOST has to be set in the docker-compose file.
The container seems not to accept the DB_HOST in the .env file.

[CHBMB]

I just tested this out with a fresh mariadb database

root@vm:~# docker exec -it mariadb bash
root@18b7f82063bd:/# mysql -u root -p
Enter password: 
Welcome to the MariaDB monitor.  Commands end with ; or \g.
Your MariaDB connection id is 14943
Server version: 10.3.15-MariaDB-1:10.3.15+maria~bionic-log mariadb.org binary distribution

Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

MariaDB [(none)]> CREATE DATABASE IF NOT EXISTS bookstack;
Query OK, 1 row affected (0.000 sec)

MariaDB [(none)]> GRANT ALL PRIVILEGES ON bookstack.* to 'root' IDENTIFIED BY 'xxxxxxxxxx';
Query OK, 0 rows affected (0.011 sec)

MariaDB [(none)]> quit
Bye
root@18b7f82063bd:/# exit
exit

Then ran bookstack with this

docker run -d \
--name=bookstack \
--net='docker \
-e PUID'='99 \
-e PGID'='100 \
-p 80:80/tcp \
-v /opt/configs/bookstack:/config:rw \
linuxserver/bookstack'

Edited /config/www/.env

# Application key
# Used for encryption where needed.
# Run `php artisan key:generate` to generate a valid key.
APP_KEY=base64:JB8sJRrHHR4+glKixrytM7DJt/AUqSpD7cYDp+WSV+w=

# Application URL
# Remove the hash below and set a URL if using BookStack behind
# a proxy, if using a third-party authentication option.
# This must be the root URL that you want to host BookStack on.
# All URL's in BookStack will be generated using this value.
APP_URL=http://${IP}:${PORT}/

# Database details
DB_HOST=mariadb
DB_DATABASE=bookstack
DB_USERNAME=root
DB_PASSWORD=xxxxxxxxxx

Logs

[fix-attrs.d] applying ownership & permissions fixes...
[fix-attrs.d] done.
[cont-init.d] executing container initialization scripts...
[cont-init.d] 10-adduser: executing...
usermod: no changes

-------------------------------------
_ ()
| | ___ _ __
| | / __| | | / \
| | \__ \ | | | () |
|_| |___/ |_| \__/


Brought to you by linuxserver.io
We gratefully accept donations at:
https://www.linuxserver.io/donate/
-------------------------------------
GID/UID
-------------------------------------

User uid: 99
User gid: 100
-------------------------------------

[cont-init.d] 10-adduser: exited 0.
[cont-init.d] 20-config: executing...
[cont-init.d] 20-config: exited 0.
[cont-init.d] 30-keygen: executing...
using keys found in /config/keys
[cont-init.d] 30-keygen: exited 0.
[cont-init.d] 50-config: executing...
App Key found - setting variable for seds
usage: nc [-46CDdFhklNnrStUuvZz] [-I length] [-i interval] [-O length]
[-P proxy_username] [-p source_port] [-q seconds] [-s source]
[-T toskeyword] [-V rtable] [-w timeout] [-X proxy_protocol]
[-x proxy_address[:port]] [destination] [port]

/// Above 4 lines repeats for 30 seconds ///

Migration table created successfully.
Migrating: 2014_10_12_000000_create_users_table
Migrated: 2014_10_12_000000_create_users_table
Migrating: 2014_10_12_100000_create_password_resets_table
Migrated: 2014_10_12_100000_create_password_resets_table
Migrating: 2015_07_12_114933_create_books_table
Migrated: 2015_07_12_114933_create_books_table
Migrating: 2015_07_12_190027_create_pages_table
Migrated: 2015_07_12_190027_create_pages_table
Migrating: 2015_07_13_172121_create_images_table
Migrated: 2015_07_13_172121_create_images_table
Migrating: 2015_07_27_172342_create_chapters_table
Migrated: 2015_07_27_172342_create_chapters_table
Migrating: 2015_08_08_200447_add_users_to_entities
Migrated: 2015_08_08_200447_add_users_to_entities
Migrating: 2015_08_09_093534_create_page_revisions_table
Migrated: 2015_08_09_093534_create_page_revisions_table
Migrating: 2015_08_16_142133_create_activities_table
Migrated: 2015_08_16_142133_create_activities_table
Migrating: 2015_08_29_105422_add_roles_and_permissions
Migrated: 2015_08_29_105422_add_roles_and_permissions
Migrating: 2015_08_30_125859_create_settings_table
Migrated: 2015_08_30_125859_create_settings_table
Migrating: 2015_08_31_175240_add_search_indexes
Migrated: 2015_08_31_175240_add_search_indexes
Migrating: 2015_09_04_165821_create_social_accounts_table
Migrated: 2015_09_04_165821_create_social_accounts_table
Migrating: 2015_09_05_164707_add_email_confirmation_table
Migrated: 2015_09_05_164707_add_email_confirmation_table
Migrating: 2015_11_21_145609_create_views_table
Migrated: 2015_11_21_145609_create_views_table
Migrating: 2015_11_26_221857_add_entity_indexes
Migrated: 2015_11_26_221857_add_entity_indexes
Migrating: 2015_12_05_145049_fulltext_weighting
Migrated: 2015_12_05_145049_fulltext_weighting
Migrating: 2015_12_07_195238_add_image_upload_types
Migrated: 2015_12_07_195238_add_image_upload_types
Migrating: 2015_12_09_195748_add_user_avatars
Migrated: 2015_12_09_195748_add_user_avatars
Migrating: 2016_01_11_210908_add_external_auth_to_users
Migrated: 2016_01_11_210908_add_external_auth_to_users
Migrating: 2016_02_25_184030_add_slug_to_revisions
Migrated: 2016_02_25_184030_add_slug_to_revisions
Migrating: 2016_02_27_120329_update_permissions_and_roles
Migrated: 2016_02_27_120329_update_permissions_and_roles
Migrating: 2016_02_28_084200_add_entity_access_controls
Migrated: 2016_02_28_084200_add_entity_access_controls
Migrating: 2016_03_09_203143_add_page_revision_types
Migrated: 2016_03_09_203143_add_page_revision_types
Migrating: 2016_03_13_082138_add_page_drafts
Migrated: 2016_03_13_082138_add_page_drafts
Migrating: 2016_03_25_123157_add_markdown_support
Migrated: 2016_03_25_123157_add_markdown_support
Migrating: 2016_04_09_100730_add_view_permissions_to_roles
Migrated: 2016_04_09_100730_add_view_permissions_to_roles
Migrating: 2016_04_20_192649_create_joint_permissions_table
Migrated: 2016_04_20_192649_create_joint_permissions_table
Migrating: 2016_05_06_185215_create_tags_table
Migrated: 2016_05_06_185215_create_tags_table
Migrating: 2016_07_07_181521_add_summary_to_page_revisions
Migrated: 2016_07_07_181521_add_summary_to_page_revisions
Migrating: 2016_09_29_101449_remove_hidden_roles
Migrated: 2016_09_29_101449_remove_hidden_roles
Migrating: 2016_10_09_142037_create_attachments_table
Migrated: 2016_10_09_142037_create_attachments_table
Migrating: 2017_01_21_163556_create_cache_table
Migrated: 2017_01_21_163556_create_cache_table
Migrating: 2017_01_21_163602_create_sessions_table
Migrated: 2017_01_21_163602_create_sessions_table
Migrating: 2017_03_19_091553_create_search_index_table
Migrated: 2017_03_19_091553_create_search_index_table
Migrating: 2017_04_20_185112_add_revision_counts
Migrated: 2017_04_20_185112_add_revision_counts
Migrating: 2017_07_02_152834_update_db_encoding_to_ut8mb4
Migrated: 2017_07_02_152834_update_db_encoding_to_ut8mb4
Migrating: 2017_08_01_130541_create_comments_table
Migrated: 2017_08_01_130541_create_comments_table
Migrating: 2017_08_29_102650_add_cover_image_display
Migrated: 2017_08_29_102650_add_cover_image_display
Migrating: 2018_07_15_173514_add_role_external_auth_id
Migrated: 2018_07_15_173514_add_role_external_auth_id
Migrating: 2018_08_04_115700_create_bookshelves_table
Migrated: 2018_08_04_115700_create_bookshelves_table
[cont-init.d] 50-config: exited 0.
[cont-init.d] 99-custom-files: executing...
[custom-init] no custom files found exiting...
[cont-init.d] 99-custom-files: exited 0.
[cont-init.d] done.
[services.d] starting services
[services.d] done.

Then it's accessible from the webui.

Have you created a database?

I think the repeating 4 lines come from this bit of the init. however I'm not the original dev so I'm not 100% sure why this was put in, presumedly to avoid a fail condition at startup if the database container wasn't ready.

[thelamer]

Yeah but the timeout is every boot up.
We expect the Env variables are set, I guess there is no harm in skipping that logic if the host is not set

[CHBMB]

Alternatively, reduce it to 10 seconds or so? And anyway to prevent it going to log and perhaps just echo a message about waiting for the database connection?

[joergr]

Have you created a database?

I did. But I don't wait for 30 seconds.
Because I thought the repeating messages indicates an error.

Alternatively, reduce it to 10 seconds or so? And anyway to prevent it going to log and perhaps just echo a message about waiting for the database connection?

Of course, the combination of both could be helpful.

What I still do not understand is the different handling of DB_HOST in docker compose file and in the .env file.
Unfortunatly I am not familiar in bash scripts so I am not able to help with that.

[CHBMB]

At the init stage we take the DB_HOST parameter and construct a correct .env using bash.

https://github.com/linuxserver/docker-bookstack/blob/master/root/etc/cont-init.d/50-config#L45

[joergr]

Ok, than the initial/first start every further start will proccess only the .env file, right?

So still have DB_HOST in the docker compose file feels like a "work around" to speed up the startup of the container and supressing the "nc ..." message.

[CHBMB]

No, that will run at every container start, but that's not where the issue lies, the issue is with this but below it.

https://github.com/linuxserver/docker-bookstack/blob/master/root/etc/cont-init.d/50-config#L58

That is run independently of whether a variable is set or not.

[mainmachine]

PR #43 submitted