Docker support? about antora-lunr HOT 5 CLOSED

Support for Docker was added.

from antora-lunr.

Would you be interested in PR with a dockerfile + github action to automatically push image to Docker Hub triggered by the release event in github?

I am thinking the PR would be better done to the antora-site-generator-lunr repo. Because the dockerfile will make use of that new node package. What do you think?

You will have to manually set the secret credentials for your docker hub account.

from antora-lunr.

Would you be interested in PR with a dockerfile + github action to automatically push image to Docker Hub triggered by the release event in github?

We could start by documenting how to extend the official base image antora/antora in order to use Antora Lunr.

I am thinking the PR would be better done to the antora-site-generator-lunr repo.

Yes, we should document it in the antora-site-generator-lunr repository (and probably add a link in here).

from antora-lunr.

Alright, the PR will contain an update to the README.md file also. I have a working docker image and it was easy enough just following the Antora guidelines. The final Dockerfile is only this:

FROM antora/antora:2.3.4

ENV DOCSEARCH_ENABLED=true \
    DOCSEARCH_ENGINE=lunr

RUN yarn global add antora-site-generator-lunr 

The output of building the docker image: docker build -t antora-lunr-search:0.5.0 -t antora-lunr-search:latest . was:

Sending build context to Docker daemon  525.8kB
Step 1/3 : FROM antora/antora:2.3.4
 ---> 137a5b66917b
Step 2/3 : ENV DOCSEARCH_ENABLED=true     DOCSEARCH_ENGINE=lunr
 ---> Running in b819ac0f7c85
Removing intermediate container b819ac0f7c85
 ---> 566f2aa78ef8
Step 3/3 : RUN yarn global add antora-site-generator-lunr
 ---> Running in 8972043a2d24
yarn global v1.22.4
[1/4] Resolving packages...
warning antora-site-generator-lunr > antora-lunr > cheerio > [email protected]: Use cheerio-select instead
[2/4] Fetching packages...
[3/4] Linking dependencies...
[4/4] Building fresh packages...
warning "[email protected]" has no binaries
Done in 7.41s.
Removing intermediate container 8972043a2d24
 ---> 4ba2c31cec04
Successfully built 4ba2c31cec04
Successfully tagged antora-lunr-search:0.5.0
Successfully tagged antora-lunr-search:latest

I could even overwrite the CMD entry point such that instead of the default antora command it can be: antora --generator antora-site-generator-lunr. This would mean less arguments to be added when calling docker run! But also less transparent and the final user will not be able to use this image to run the default antora-site-generator (this should not be a problem, because he can use the official antora image for the default generator).

What do you think?

I personally would like to have the antora --generator antora-site-generator-lunr set by default, but willing to compromise on this one 😃

from antora-lunr.

Maybe the DockerHub image name should contain the antora version also. I propose to name it antora-v2.3.4-lunr:0.5.0 with the tag only pointing to your versioning scheme.

What do you think?

EDIT: I have made the CI file and the docker image is available here.

I only have to write down the README.md part and I will create the PR to finalize there the details.

from antora-lunr.