Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[DOCUMENTATION] port settings for REST api in docker compose file.

Open Beginner friendly
#14,788 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Open the RESTful API V2 documentation at the linked Enable RESTful Services section and review the Docker Compose example. Document the additional 18080:18080 port alongside the existing 6667:6667 mapping, then verify that the example explains the port required to enable the REST service.

Written by the indexing model from the issue text.

Description

On documentation page for RESTful API V2 it will be helpful if adjusted docker compose file with additional port property is mentioned in the area of Enable RESTful Services.

ports:
      - "6667:6667"
      - "18080:18080"

When users want to enable REST service, an additional port has to be added in the docker compose file.

Best regards
André

Dominant language
Java
Stars
6.4k
Forks
1.2k
Avg merge
1d 8h
Merged PRs (30d)
129

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.

More from apache/iotdb

All issues in apache/iotdb

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.