From 8d7cd3d46d02001bae57365e28f1529dff534a11 Mon Sep 17 00:00:00 2001
From: Linwei Zhang <lewiszlw520@gmail.com>
Date: Sat, 28 Dec 2024 00:57:34 +0800
Subject: [PATCH] Add orbstack guide

---
 CONTRIBUTING.md               |  2 +-
 docs/contributing/orbstack.md | 39 +++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 1 deletion(-)
 create mode 100644 docs/contributing/orbstack.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 71a222e14..79a3e6ba6 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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)
 
diff --git a/docs/contributing/orbstack.md b/docs/contributing/orbstack.md
new file mode 100644
index 000000000..29eb09dc5
--- /dev/null
+++ b/docs/contributing/orbstack.md
@@ -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"]
+    }
+   ```
\ No newline at end of file