Updated the Documentation for Docker by Omitting the Exposure of the MySQL API's Port #10360
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/setup/self-hosted/docker.mdx
Outdated
| - `mindsdb/mindsdb` is a Docker image provided by MindsDB. You can choose a different one from the list above. | ||
|
|
||
| <Tip> | ||
| By default, MindsDB starts only the `http` API. You can define which APIs to start by passing the `MINDSDB_APIS` environment variable with a comma-separated list when running the container as shown below. To expose the ports for the APIs, you need to add the respective ports to the command with the `-p` flag. |
There was a problem hiding this comment.
Thank you Minura. This looks good. A couple of small things:
Let's change
`http` API
to
HTTP API
like it is above.
Also, please let's add a link to the environment variables doc page.
martyna-mindsdb
approved these changes
Jan 14, 2025
MinuraPunchihewa
temporarily deployed
to
alpha-dev
GitHub Actions
Inactive
MinuraPunchihewa
temporarily deployed
to
hackathon
GitHub Actions
Inactive
MinuraPunchihewa
temporarily deployed
to
staging
GitHub Actions
Inactive
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the documentation for running MindsDB via Docker by omitting the exposure of the MySQL API's port because as mentioned in the issue below, by default, only the HTTP API is started.
A tip for running the other APIs using the
MINDSDB_APISenvironment variable has also been added.Fixes https://linear.app/mindsdb/issue/BE-612/update-the-documentation-for-docker-by-removing-exposure-of-the-mysql
Type of change
The use of the
MINDSDB_APISenvironment variable depends on #10354