Skip to content

Commit

Permalink
Add orbstack guide (#856)
Browse files Browse the repository at this point in the history
  • Loading branch information
lewiszlw authored Dec 30, 2024
1 parent 94c433b commit 044750f
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ cargo 1.69.0 (6e9a83356 2023-04-12)

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.

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

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

Expand Down
39 changes: 39 additions & 0 deletions docs/contributing/orbstack.md
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"]
}
```

0 comments on commit 044750f

Please sign in to comment.