Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

preview-docs in Docker image doesn't exit on ctrl+c #1698

Open
akrabat opened this issue Aug 29, 2024 · 2 comments
Open

preview-docs in Docker image doesn't exit on ctrl+c #1698

akrabat opened this issue Aug 29, 2024 · 2 comments
Labels
p3 Type: Bug Something isn't working

Comments

@akrabat
Copy link

akrabat commented Aug 29, 2024

Describe the bug

When running the preview-docs command using the Docker image, it doesn't respond to ctrl+c to exit.

To Reproduce
Steps to reproduce the behaviour:

  1. Create a valid openapi.yaml file.

  2. Run this command:

     docker run --rm -p 8080:8080 -v $PWD:/spec redocly/cli preview-docs \
     openapi.yaml --use-community-edition --host 0.0.0.0
    
  3. Try to exit by pressing ctrl+c as you would do with the npm version

  4. Note that redocly hasn't exited.

Note, I have also tried adding the -t and -i flags to the docker command.

Expected behaviour

The docker container exits and control is returned to the shell in the terminal.

i.e. I expected it to behave in the same way as docker run redis does when you press ctrl+c.

Redocly Version(s)

$ docker run --rm redocly/cli --version
1.22.0

Node.js Version(s)

Whatever is in the Docker image.

OS, environment

MacOS 14.6.1 (Apple Silicon). Docker Desktop 4.31.0 (153195).

@akrabat akrabat added the Type: Bug Something isn't working label Aug 29, 2024
@tatomyr
Copy link
Contributor

tatomyr commented Sep 4, 2024

I confirm this is a bug. Thanks for reporting it!

@tatomyr tatomyr added the p3 label Sep 4, 2024
@asvng
Copy link

asvng commented Jan 3, 2025

Works for me if I add the --init flag to the docker run command:

docker run --init --rm -p 8080:8080 -v $PWD:/spec redocly/cli preview-docs \
 openapi.yaml --use-community-edition --host 0.0.0.0

See: https://github.com/nodejs/docker-node/blob/main/docs/BestPractices.md#handling-kernel-signals (requires Docker 1.13)

Maybe just the docs need updating.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
p3 Type: Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants