Add orbstack guide #856
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,39 @@ | ||||||
| <!-- | ||||||
| ~ Licensed to the Apache Software Foundation (ASF) under one | ||||||
| ~ or more contributor license agreements. See the NOTICE file | ||||||
| ~ distributed with this work for additional information | ||||||
| ~ regarding copyright ownership. The ASF licenses this file | ||||||
| ~ to you under the Apache License, Version 2.0 (the | ||||||
| ~ "License"); you may not use this file except in compliance | ||||||
| ~ with the License. You may obtain a copy of the License at | ||||||
| ~ | ||||||
| ~ http://www.apache.org/licenses/LICENSE-2.0 | ||||||
| ~ | ||||||
| ~ Unless required by applicable law or agreed to in writing, | ||||||
| ~ software distributed under the License is distributed on an | ||||||
| ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||||||
| ~ KIND, either express or implied. See the License for the | ||||||
| ~ specific language governing permissions and limitations | ||||||
| ~ under the License. | ||||||
| --> | ||||||
|
|
||||||
| # OrbStack as a docker alternative on macOS | ||||||
| 1. Install OrbStack by downloading [installer](https://orbstack.dev/download) or using Homebrew. | ||||||
| ```shell | ||||||
| brew install orbstack | ||||||
| ``` | ||||||
|
|
||||||
| 2. Migrate Docker data | ||||||
| ```shell | ||||||
| orbstack migrate docker | ||||||
| ``` | ||||||
|
|
||||||
| 3. (Optional) Add registry mirrors | ||||||
|
|
||||||
| You can edit the config directly at `~/.orbstack/config/docker.json` and restart the engine with `orb restart docker`. | ||||||
|
|
||||||
| ``` | ||||||
| { | ||||||
| "registry-mirrors": ["https://registry.docker.ir", "https://docker.iranserver.com"] | ||||||
|
There was a problem hiding this comment. nit: why are these registry mirrors part of the PR? The only reference i can find about these registry mirrors is here orbstack/orbstack#51 (comment) It doesnt seem like these mirrors are commonly used can we remove this recommendation or change it to a more commonly used mirror? There was a problem hiding this comment. These registry mirrors are just example, copied from orbstack/orbstack#51 (comment) . I think we can change it like There was a problem hiding this comment. that sounds good to me, thanks! Let's see if I can change it right here from github:
Suggested change
edit: guess not since its already merged. Would you like to make the change? |
||||||
| } | ||||||
| ``` | ||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding guide about how to use a tool seems strange to me, unless we need project-specific settings. It should be enough to link to the tool's doc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have podman guide in repo. I think adding orbstack guide is helpful to new contributer as it's not trival to run tests like other rust projects, we should lower the threshold for new contributers as much as possible.