Skip to content

Document changes to noVNC API  #6

@bobwhitelock

Description

@bobwhitelock

In 5bd26e1 you change the API for connecting to a session from rfb.connect(host, port, password, path), as in the original noVNC, to rfb.connect(url, password). It doesn't really matter to me either way which is used, but it did just cause me lots of confusion as to why my code wasn't authenticating correctly when a password was required; it turns out that this is because the port was actually being sent instead, although your documentation makes no mention of the fact that some parts of the API have changed and just states that RFB is based on the original.

It would be very useful to clearly document where changes are made to the noVNC API. Even better, it might be better to avoid making these changes where possible, to make noVNC-node an easy-to-use, modular replacement for noVNC, requiring as little as necessary adaptation of existing code. I'm opening this issue rather than just fixing this as there may be other undocumented changes to the API, which it would also be worth documenting/fixing.

As a broader point I think you'll have a hard time keeping up-to-date with upstream changes as, in addition to changing the API, this project just copies the noVNC codebase rather than forking it directly, making it more difficult to merge in additions to noVNC. Thanks.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions