apache / apache/iotdb

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

Open Beginner friendly
#14,788 2 comments 2 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
6.4k
Forks
1.2k
Avg merge
1d 23h
Merged PRs (30d)
115

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](https://iotdb.apache.org/UserGuide/latest/API/RestServiceV2.html#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é

Contributor guide

Open the contributing guide

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.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.