The Docker image `ghcr.io/actions/actions-runner` is missing documentation

Open Beginner friendly
#4,456 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
docker, docker-compose
Domain
devops, documentation

Research direction

Start by reviewing the Docker package page, issue #367, and pull request #2250 to understand the existing runner image documentation and intended usage. Document how to configure and start ghcr.io/actions/actions-runner with Docker CLI and Docker Compose; done means the package has clear usage instructions for both approaches.

Written by the indexing model from the issue text.

Description

bug

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://github.com/actions/runner/pkgs/container/actions-runner .

Expected behavior
A clear and concise description of what you expected to happen.

  • The Docker image ghcr.io/actions/actions-runner should have proper documentation explaining how to configure or start the Github Runner via the Docker CLI or Docker Compose files.

Runner Version and Platform

Version of your runner?

OS of the machine running the runner? OSX/Windows/Linux/...

  • Linux

What's not working?

Please include error messages and screenshots.

  • Image

Job Log Output

If applicable, include the relevant part of the job / step log output here. All sensitive information should already be masked out, but please double-check before pasting here.

  • It doesn't seem important.

Runner and Worker's Diagnostic Logs

If applicable, add relevant diagnostic log information. Logs are located in the runner's _diag folder. The runner logs are prefixed with Runner_ and the worker logs are prefixed with Worker_. Each job run correlates to a worker log. All sensitive information should already be masked out, but please double-check before pasting here.

  • It doesn't seem important.
Dominant language
C#
Stars
6.3k
Forks
1.4k
Avg merge
1d 16h
Merged PRs (30d)
24

Contributor guide

No contributing guide indexed for this repository

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.

More from actions/runner

All issues in actions/runner

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.