Skip to content

Commit 044750f

Browse files
authored
Add orbstack guide (#856)
1 parent 94c433b commit 044750f

File tree

2 files changed

+40
-1
lines changed

2 files changed

+40
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ cargo 1.69.0 (6e9a83356 2023-04-12)
116116

117117
Currently, iceberg-rust uses Docker to set up environment for integration tests. Native Docker has some limitations, please check (https://github.com/apache/iceberg-rust/pull/748). Please use Orbstack or Podman.
118118

119-
For MacOS users, you can install [OrbStack](https://orbstack.dev/) as a docker alternative.
119+
For MacOS users, you can install [OrbStack as a docker alternative](docs/contributing/orbstack.md).
120120

121121
For podman, refer to [Using Podman instead of Docker](docs/contributing/podman.md)
122122

docs/contributing/orbstack.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!--
2+
~ Licensed to the Apache Software Foundation (ASF) under one
3+
~ or more contributor license agreements. See the NOTICE file
4+
~ distributed with this work for additional information
5+
~ regarding copyright ownership. The ASF licenses this file
6+
~ to you under the Apache License, Version 2.0 (the
7+
~ "License"); you may not use this file except in compliance
8+
~ with the License. You may obtain a copy of the License at
9+
~
10+
~ http://www.apache.org/licenses/LICENSE-2.0
11+
~
12+
~ Unless required by applicable law or agreed to in writing,
13+
~ software distributed under the License is distributed on an
14+
~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
~ KIND, either express or implied. See the License for the
16+
~ specific language governing permissions and limitations
17+
~ under the License.
18+
-->
19+
20+
# OrbStack as a docker alternative on macOS
21+
1. Install OrbStack by downloading [installer](https://orbstack.dev/download) or using Homebrew.
22+
```shell
23+
brew install orbstack
24+
```
25+
26+
2. Migrate Docker data
27+
```shell
28+
orbstack migrate docker
29+
```
30+
31+
3. (Optional) Add registry mirrors
32+
33+
You can edit the config directly at `~/.orbstack/config/docker.json` and restart the engine with `orb restart docker`.
34+
35+
```
36+
{
37+
"registry-mirrors": ["https://registry.docker.ir", "https://docker.iranserver.com"]
38+
}
39+
```

0 commit comments

Comments
 (0)