redhat-developer / redhat-developer/yaml-language-server

Docker command in README doesn't quite work out of the box

Open
#1,079 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.5k
Forks
352
Avg merge
2d 7h
Merged PRs (30d)
11

Description

Context: Using Fedora Silverblue 42 + Podman. This issue may be Podman specific

Describe the bug

Using the Docker command in the README (ref):

docker run -it quay.io/redhat-developer/yaml-language-server:latest

The server doesn't appear to work as expected, ignoring SIGINT/SIGTERM and crashing soon after startup when started using emacs lsp-mode.

With a clue from #1012 I discovered that adding --pid=host seems to fix the issue 👍

Other flyby suggestions:

  • I think the -t command is unnecessary because you don't normally use a TTY to interact with a language server
  • maybe throwing in an --rm might be beneficial for users as this isn't a stateful container.

Saving the following as yaml-language-server in my $PATH appears to work as expected.

#!/bin/bash                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
exec podman run --pid=host --rm -i quay.io/redhat-developer/yaml-language-server:1.18.0 "$@" 

Suggested Change

Update the docker command in README.md to

docker run --rm -i --pid=host quay.io/redhat-developer/yaml-language-server:latest

Environment

  • Windows
  • Mac
  • Linux
  • other (please specify)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open README.md at the Docker usage section referenced in the issue and compare the current command with the suggested command. Done means the README shows the --rm, -i, and --pid=host options in the requested Docker command.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.