Unverified Commit 3d855f8f authored by Kroese's avatar Kroese Committed by GitHub
Browse files

docs: Readme

parent 0e132351

readme.md

+10 −12
Original line number Diff line number Diff line 
<h1 align="center">OSX<br />

<div align="center">

<a href="https://github.com/seitenca/osx/"><img src="https://github.com/seitenca/osx/raw/master/.github/logo.png" title="Logo" style="max-width:100%;" width="128" /></a>

<a href="https://github.com/dockur/osx/"><img src="https://github.com/dockur/osx/raw/master/.github/logo.png" title="Logo" style="max-width:100%;" width="128" /></a>

</div>

<div align="center">
@@ -10,8 +10,8 @@ OSX inside a Docker container. 


## Features



 - Auto image downloader

 - KVM acceleration

 - Image downloader

 - Web-based viewer



## Usage
@@ -21,8 +21,7 @@ Via Docker Compose: 
```yaml

services:

  osx:

    build:

      dockerfile: Dockerfile

    image: dockurr/osx

    container_name: osx

    environment:

      VERSION: "ventura"
@@ -35,13 +34,12 @@ services: 
      - 5900:5900/tcp

      - 5900:5900/udp

    stop_grace_period: 2m



```



Via Docker CLI:



```bash

docker run -it --rm -p 8006:8006 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 todo/osx

docker run -it --rm -p 8006:8006 --device=/dev/kvm --cap-add NET_ADMIN --stop-timeout 120 dockurr/osx

```



Via Kubernetes:
@@ -58,15 +56,15 @@ kubectl apply -f kubernetes.yml 
  

  - Start the container and connect to [port 8006](http://localhost:8006) using your web browser.



  - **With the keyboard!!** select "macOs Base System" to begin the installation

  - Select `macOs Base System` with your keyboard to begin the installation.



  - Select Disk Utility and then select the "QEMU HARDDISK Media" that has the size you specified

  - Select `Disk Utility` and then select the `QEMU HARDDISK Media` that has the size you specified.



  - Click erase to format the disk, you can put the name you want.

  - Click `Erase` to format the disk, you can give it any name you want.



  - When finished go back by closing the window and the proced the installation clicking "Reinstall macOS *version*"

  - When finished, go back by closing the window and then proceed the installation by clicking `Reinstall macOS <version>`.

  

  - When prompted where to install it select the disk you created 

  - When prompted where to install it, select the disk you created.



  - Once you see the desktop, your OSX installation is ready for use.