Skip to content

Suggestions: README Clarifications Needed #47

@TheRainstorm

Description

@TheRainstorm

This is a great project! I successfully deployed it on my own machine using Docker by following the README.

During the setup, I noticed two areas in the README that could be improved:

​​1. Missing Web UI Access Instructions:​​ The README doesn't explicitly mention how to access the web interface after starting the container. Initially, I tried accessing http://server:8089/ but only encountered a 404 Page Not Found error. This led me to suspect a Docker configuration issue before I realized the correct path required the /wolweb suffix (e.g., http://server:8089/wolweb). Adding this access point detail would be very helpful for new users.
​​2. Clarification on Pre-built Docker Image Availability:​​ The README currently mentions building your own Docker image. However, when I followed the instructions and examined the provided docker-compose.yml file, I saw that it already ​​uses a pre-built image​​. Maybe adding a simple docker run command example​​ that uses the pre-built image would be very beneficial, so user know there already is a pre-built docker image.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions