Docker build fails with missing node-pre-gyp

[taladar]

Describe the Bug

Trying to naively build the Dockerfile in the repository (at tag 10.1.3, the latest as of right now) results in an error while building argon2@0.3.30 that it is missing the node-pre-gyp binary.

To Reproduce

docker build -t directus9:10.1.3 .

[...]
Progress: resolved 2396, reused 0, downloaded 2382, added 2394
.../fontawesome-common-types postinstall$ node attribution.js
.../fontawesome-common-types postinstall$ node attribution.js
.../fontawesome-common-types postinstall: Font Awesome Free 0.2.36 by @fontawesome - https://fontawesome.com
.../fontawesome-common-types postinstall: License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
.../fontawesome-common-types postinstall: Done
.../fontawesome-common-types postinstall: Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com
.../fontawesome-common-types postinstall: License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
.../fontawesome-common-types postinstall: Copyright 2023 Fonticons, Inc.
.../fontawesome-common-types postinstall: Done
Progress: resolved 2396, reused 0, downloaded 2383, added 2396, done
.../node_modules/vue-demi postinstall$ node ./scripts/postinstall.js
.../node_modules/vue-demi postinstall: Done
.../@fortawesome/fontawesome-svg-core postinstall$ node attribution.js
.../@fortawesome/fontawesome-svg-core postinstall$ node attribution.js
.../@fortawesome/free-brands-svg-icons postinstall$ node attribution.js
.../@fortawesome/free-regular-svg-icons postinstall$ node attribution.js
.../@fortawesome/fontawesome-svg-core postinstall: Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com
.../@fortawesome/fontawesome-svg-core postinstall: License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
.../@fortawesome/fontawesome-svg-core postinstall: Copyright 2023 Fonticons, Inc.
.../@fortawesome/free-solid-svg-icons postinstall$ node attribution.js
.../@fortawesome/fontawesome-svg-core postinstall: Done
.../@fortawesome/fontawesome-svg-core postinstall: Font Awesome Free 1.2.36 by @fontawesome - https://fontawesome.com
.../@fortawesome/fontawesome-svg-core postinstall: License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
.../@fortawesome/fontawesome-svg-core postinstall: Done
.../@fortawesome/free-brands-svg-icons postinstall: Font Awesome Free 6.4.0 by @fontawesome - https://fontawesome.com
.../@fortawesome/free-brands-svg-icons postinstall: License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
.../@fortawesome/free-brands-svg-icons postinstall: Copyright 2023 Fonticons, Inc.
.../@fortawesome/free-brands-svg-icons postinstall: Done
.../@fortawesome/free-solid-svg-icons postinstall: Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com
.../@fortawesome/free-solid-svg-icons postinstall: License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
.../@fortawesome/free-regular-svg-icons postinstall: Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com
.../@fortawesome/free-regular-svg-icons postinstall: License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)
.../@fortawesome/free-solid-svg-icons postinstall: Done
.../@fortawesome/free-regular-svg-icons postinstall: Done
.../esbuild@0.18.20/node_modules/esbuild postinstall$ node install.js
.../esbuild@0.17.17/node_modules/esbuild postinstall$ node install.js
.../esbuild@0.20.2/node_modules/esbuild postinstall$ node install.js
.../esbuild@0.18.20/node_modules/esbuild postinstall: Done
.../esbuild@0.17.17/node_modules/esbuild postinstall: Done
.../esbuild@0.20.2/node_modules/esbuild postinstall: Done
.../sharp@0.33.3/node_modules/sharp install$ node install/check
.../sharp@0.33.3/node_modules/sharp install: Done
.../argon2@0.30.3/node_modules/argon2 install$ node-pre-gyp install --fallback-to-build
.../argon2@0.30.3/node_modules/argon2 install: sh: node-pre-gyp: not found

Directus Version

v10.1.3

Hosting Strategy

Self-Hosted (Docker Image)

[Jakeksii]

I managed to build the image by adding this line in dockerfile:

# Install node-pre-gyp
RUN npm install -g node-pre-gyp

Now it builded fine, but additional issue came:
When i started docker image it couldn't find shared extension dependencys:

2024-12-16 17:01:20 [15:01:19.960] WARN: Couldn't find shared extension dependency "@wbce-d9/extensions-sdk"
2024-12-16 17:01:20 [15:01:19.960] WARN: Couldn't find shared extension dependency "vue"
2024-12-16 17:01:20 [15:01:19.960] WARN: Couldn't find shared extension dependency "vue-router"
2024-12-16 17:01:20 [15:01:19.960] WARN: Couldn't find shared extension dependency "vue-i18n"
2024-12-16 17:01:20 [15:01:19.960] WARN: Couldn't find shared extension dependency "pinia"

Full dockerfile:

# syntax=docker/dockerfile:1.4

####################################################################################################
## Build Packages

FROM node:18-alpine AS builder
WORKDIR /directus

ENV NODE_OPTIONS=--max-old-space-size=8192

COPY package.json .
RUN corepack enable && corepack prepare

# Install node-pre-gyp
RUN npm install -g node-pre-gyp

COPY pnpm-lock.yaml .
RUN pnpm fetch
COPY . .
RUN pnpm install --recursive --offline --frozen-lockfile

RUN : \
	&& npm_config_workspace_concurrency=1 pnpm run build \
	&& pnpm --filter directus9 deploy --prod dist \
	&& cd dist \
	&& pnpm pack \
	&& tar -zxvf *.tgz package/package.json \
	&& mv package/package.json package.json \
	&& rm -r *.tgz package \
	&& mkdir -p database extensions uploads \
	;

####################################################################################################
## Create Production Image

FROM node:18-alpine AS runtime

USER node

WORKDIR /directus

EXPOSE 8055

ENV \
	DB_CLIENT="sqlite3" \
	DB_FILENAME="/directus/database/database.sqlite" \
	EXTENSIONS_PATH="/directus/extensions" \
	STORAGE_LOCAL_ROOT="/directus/uploads" \
	NODE_ENV="production" \
	NPM_CONFIG_UPDATE_NOTIFIER="false"

COPY --from=builder --chown=node:node /directus/dist .

CMD : \
	&& node /directus/cli.js bootstrap \
	&& node /directus/cli.js start \
	;

[adussarps]

Hello @taladar and @Jakeksii,
Thanks for taking a look at the docker image. We do not maintain it extensively, as we use a simpler one based only on the NPM release.

As you guys noticed, there is a bit of cleaning to do around dependency resolution to make it work again.
Feel free to deep a little deeper into this :).

Otherwise, on my side, I think I'll have a look around Christmas.

Also, if you want to have a simple Directus9 image that is working, I'll share ours here quickly.

[taladar]

If you have a working one to share that would be appreciated. I tried the one from the other repository in this organization too but that one seems to only install anything when you start the Docker image and then asks if I want to install directus 11 even though the image is called something with directus9 too.

[adussarps]

So here is the image to run from a base directus 9 repo.

FROM node:18

# Copy package.json and package-lock.json first to leverage Docker layer caching
COPY package*.json /app/

# Set working directory
WORKDIR /app

# Install dependencies
RUN npm install

# Copy the rest of the application code
COPY . .

# Start Directus server
CMD ["npx", "directus", "start"]

Be sure to have "directus9" in your package.json.

{
  "name": "api-with-d9",
  "version": "1.0.0",
  "description": "api using d9 and deployed with webcapsule",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@ariga/atlas": "^0.26.0",
    "@wbce-d9/directus9": "^10.1.3",
    "pg": "^8.11.3"
  }
}

I'll double-check that https://github.com/LaWebcapsule/wbce-base-directus-9 is working fine though.

[taladar]

I believe that was the other repo I tried that asked on startup if I wanted to install directus 11

[adussarps]

Yes indeed, there is an issue as it doesn't find "directus" locally.

As a quick fix just change this line:

CMD ["npx", "directus", "start"]

to

CMD ["npx", "@wbce-d9/directus9", "start"]

[adussarps]

I've updated the wbce-base-directus-9 with the working docker file ;)

[Jakeksii]

Hello, thank you very much i managed to build docker image from wbce-base-directus-9

But i ran into issue when i start the instance:

directus_1  | [13:39:06.319] WARN: Couldn't find shared extension dependency "@wbce-d9/extensions-sdk"
directus_1  | [13:39:06.320] WARN: Couldn't find shared extension dependency "vue"
directus_1  | [13:39:06.320] WARN: Couldn't find shared extension dependency "vue-router"
directus_1  | [13:39:06.320] WARN: Couldn't find shared extension dependency "vue-i18n"
directus_1  | [13:39:06.320] WARN: Couldn't find shared extension dependency "pinia"

It seems that directus cannot find shared extension deps, i think i shouldn't have to install those dependencies manually and they should be included automatically. Is there some kind of linkin argument/.env entry that i need to provided for directus to find the deps?

And also i got some permission issues, these i can handle myself:
directus_1 | [13:39:06.358] WARN: Upload directory (/app/uploads) is not read/writeable!

[Jakeksii]

Hello, so i have been working on this issue for several days now.

for version 10.1.3 i couldn't fix the Couldn't find shared extension dependency error.

But what i have found:
Version LaWebcapsule/directus9:10.1.1 works without any problems and i can create fully working docker image from that release.
i have it released on docker goodboyinnovations/directus9

Version LaWebcapsule/directus9:10.1.3 does not work as it has error for witch @taladar opened this issue.

I think the issue lies somewhere in this commit: b59e970
as there was some huge package changes.

so at least for now we can use that version 10.1.1

[louisdussarps]

Sorry for the very late response. We should have addressed this issue earlier.
Since the latest releases, we recommend either using the Docker image or, for local development, using our projen configuration as described here.
The build workflow has evolved since this issue was opened, and the problem reported here should no longer be an issue.