add documentation to repo

website/.gitignore

@@ -0,0 +1,4 @@
+/public
+resources/
+node_modules/
+.hugo_build.lock

website/.nvmrc

@@ -0,0 +1 @@
+lts/*

website/Makefile

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: Copyright The Colima Authors
+# SPDX-License-Identifier: Apache-2.0
+# See also: package.json
+NPM ?= npm
+
+build serve: _output/docsy node_modules/.bin/hugo
+	$(NPM) run $@
+
+_output/docsy:
+	$(MAKE) -C .. docsy
+
+node_modules/.bin/hugo:
+	$(NPM) install
+
+clean:
+	$(NPM) run $@
+	rm -Rf _output

website/README.md

@@ -0,0 +1,3 @@
+# The source of the Colima website (https://colima.run)
+
+This directory is the [Netlify base directory](https://docs.netlify.com/configure-builds/overview/) of [https://colima.run](https://colima.run/) .

website/assets/scss/_variables_project.scss

@@ -0,0 +1,54 @@
+/*
+
+Add styles or override variables from the theme here.
+
+*/
+
+$display1-weight: 500 !default;
+$display2-weight: 100 !default;
+
+$primary: rgb(255, 255, 255) !default;
+$secondary: rgb(66.274512%, 81.176472%, 21.960784%) !default;
+$dark: black !default;
+$td-sidebar-tree-root-color: #222 !default;
+
+.nav-shadow {
+  box-shadow: 0 2px 2px -2px rgba(0, 0, 0, .2);
+}
+
+.nav-link {
+  text-shadow: none !important;
+}
+
+.cncf-logo {
+  width: 20rem;
+  max-width: 80%;
+}
+
+.join-community {
+  color: $dark !important;
+  background: $secondary !important;
+
+  .td-arrow-down:before {
+    border-color: $secondary transparent transparent transparent !important;
+  }
+}
+
+.td-search__input {
+  color: var(--bs-body-color) !important;
+  border: 1px solid var(--bs-gray-400) !important;
+}
+
+.td-search__input:focus {
+  color: inherit !important;
+  border-color: var(--bs-body-bg) !important;
+  box-shadow: 0 0 0 2px var(--bs-primary) !important;
+}
+
+.td-search__input::placeholder {
+  color: var(--bs-gray) !important;
+}
+
+.td-search__icon {
+  color: $secondary !important;
+}

website/config.yaml

@@ -0,0 +1,15 @@
+# THIS IS A TEST CONFIG ONLY!
+# FOR THE CONFIGURATION OF YOUR SITE USE hugo.yaml.
+#
+# As of Docsy 0.7.0, Hugo 0.110.0 or later must be used.
+#
+# The sole purpose of this config file is to detect Hugo-module builds that use
+# an older version of Hugo.
+#
+# DO NOT add any config parameters to this file. You can safely delete this file
+# if your project is using the required Hugo version.
+
+module:
+  hugoVersion:
+    extended: true
+    min: 0.110.0

website/content/en/_index.html

@@ -0,0 +1,30 @@
++++
+title = "Colima"
+linkTitle = "Colima"
+
++++
+
+{{< blocks/cover title="" image_anchor="top" height="min" color="white" >}}
+<div class="mx-auto">
+  <a class="btn btn-lg btn-secondary mr-3 mb-4" href="{{< relref "/docs" >}}">
+  Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
+  </a>
+</div>
+{{< /blocks/cover >}}
+
+{{% blocks/lead color="secondary" %}}
+<p>
+  <strong>What is Colima?</strong>
+</p>
+
+<p>
+  Colima provides container runtimes on macOS (and Linux) with minimal setup. Docker, containerd, and Kubernetes on macOS with a simple CLI.
+</p>
+{{% /blocks/lead %}}
+{{< blocks/section color="dark" type="row" >}}
+
+  {{< blocks/helpfullinks >}}
+
+{{< /blocks/section >}}
+
+{{< blocks/cncf >}}

website/content/en/docs/_index.md

@@ -0,0 +1,34 @@
+---
+title: "Colima: Container Runtimes on macOS"
+linkTitle: Documentation
+menu: { main: { weight: 20 } }
+weight: 20
+---
+
+{{% fixlinks %}}
+Colima provides container runtimes on macOS (and Linux) with minimal setup.
+
+✅ Simple CLI to start/stop container runtime
+
+✅ Built-in support for [Docker](https://www.docker.com) (default)
+
+✅ Support for [containerd](https://containerd.io) and [Kubernetes](https://kubernetes.io)
+
+✅ Automatic file sharing
+
+✅ Automatic port forwarding
+
+✅ Intel on Intel
+
+✅ ARM on ARM
+
+✅ Various guest Linux distributions: [AlmaLinux](./templates/almalinux.yaml), [Alpine](./templates/alpine.yaml), [Arch Linux](./templates/archlinux.yaml), [Debian](./templates/debian.yaml), [Fedora](./templates/fedora.yaml), [openSUSE](./templates/opensuse.yaml), [Oracle Linux](./templates/oraclelinux.yaml), [Rocky](./templates/rocky.yaml), [Ubuntu](./templates/ubuntu.yaml) (default), ...
+
+Related project: [sshocker (ssh with file sharing and port forwarding)](https://github.com/lima-vm/sshocker)
+
+## Motivation
+
+Colima was created to provide a simple and easy-to-use alternative for running Docker Desktop on macOS.
+It leverages [Lima](https://github.com/lima-vm/lima) to provide Linux virtual machines with automatic file sharing and port forwarding.
+The goal is to provide Docker (and Kubernetes) on macOS with minimal setup, while also supporting containerd and other container runtimes.
+{{% /fixlinks %}}

website/content/en/docs/community/_index.md

@@ -0,0 +1,20 @@
+---
+title: Community
+weight: 400
+---
+
+The GitHub repo of Colima can be found at <https://github.com/abiosoft/colima>.
+
+## Communication channels
+
+- [GitHub Discussions](https://github.com/abiosoft/colima/discussions)
+
+- [GitHub Issues](https://github.com/abiosoft/colima/issues) for bug reports and feature requests
+
+- See <https://github.com/abiosoft/colima/blob/main/SECURITY.md> for how to report security issues.
+
+## Related projects
+
+### Underlying technology
+- [Lima](https://github.com/lima-vm/lima): The virtualization technology that powers Colima
+

website/content/en/docs/community/contributing.md

@@ -0,0 +1,55 @@
+---
+title: Contributing
+weight: 20
+---
+
+## Reporting issues
+
+Bugs and feature requests can be submitted via <https://github.com/abiosoft/colima/issues>.
+
+For asking questions, use [GitHub Discussions](https://github.com/abiosoft/colima/discussions).
+
+For reporting vulnerabilities, see <https://github.com/abiosoft/colima/blob/main/SECURITY.md>.
+
+## Contributing code
+
+### Getting Involved
+
+We welcome new contributors! Here are some ways to get started and engage with the Colima community:
+
+#### Introduce Yourself
+
+- Join our [GitHub Discussions](https://github.com/abiosoft/colima/discussions) and say hello! Let us know your interests and how you'd like to help.
+
+#### Find Open Issues
+
+- Browse [GitHub Issues](https://github.com/abiosoft/colima/issues) labeled as [`good first issue`](https://github.com/abiosoft/colima/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) for tasks that are great for new contributors.
+- If you're unsure where to start, ask in the discussions or open a new issue.
+
+We're glad to have you here, your contributions make Colima better!
+
+### Developer Certificate of Origin
+
+Every commit must be signed off with the `Signed-off-by: REAL NAME <[email protected]>` line.
+
+Use the `git commit -s` command to add the Signed-off-by line.
+
+### Licensing
+
+Colima is licensed under the terms of [MIT License](https://github.com/abiosoft/colima/blob/main/LICENSE).
+
+### Sending pull requests
+
+Pull requests can be submitted to <https://github.com/abiosoft/colima/pulls>.
+
+It is highly suggested to add tests for every non-trivial pull request.
+A test can be implemented as a unit test rather than an integration test when possible,
+to avoid slowing the integration test CI.
+
+### Code review process
+
+Pull requests require approval from project maintainers before merging.
+
+Maintainers shouldn't merge their own pull requests without approval from at least one other maintainer.
+
+This rule does not apply to trivial pull requests such as fixing typos or CI failures.

website/content/en/docs/config/_index.md

@@ -0,0 +1,18 @@
+---
+title: Configuration guide
+weight: 5
+---
+
+For all the configuration items, see <https://github.com/abiosoft/colima/blob/master/README.md>.
+
+The current default spec:
+
+- OS: Ubuntu
+- CPU: 2 cores
+- Memory: 2 GiB
+- Disk: 100 GiB
+- Runtime: Docker
+- Mounts: `$HOME`
+- SSH: Accessible via `colima ssh`
+
+For environment variables and advanced configuration, see [Environment Variables](./environment-variables/).

website/content/en/docs/config/environment-variables.md

@@ -0,0 +1,71 @@
+---
+title: Environment Variables
+weight: 80
+---
+
+## Environment Variables
+
+This page documents the environment variables used in Colima.
+
+### `COLIMA_HOME`
+
+- **Description**: Specifies the Colima home directory where configurations and data are stored.
+- **Default**: `~/.colima`
+- **Usage**:
+  ```sh
+  export COLIMA_HOME=~/.colima-custom
+  colima start
+  ```
+
+### `COLIMA_PROFILE`
+
+- **Description**: Specifies the name of the Colima profile to use.
+- **Default**: `default`
+- **Usage**:
+  ```sh
+  export COLIMA_PROFILE=docker-profile
+  colima start
+  ```
+
+### `DOCKER_HOST`
+
+- **Description**: Automatically set by Colima to point to the Docker socket. Usually you don't need to set this manually.
+- **Default**: Set by Colima when Docker runtime is active
+- **Usage**:
+  ```sh
+  # Automatically set by Colima, but can be overridden
+  export DOCKER_HOST=unix://$HOME/.colima/default/docker.sock
+  ```
+
+## Lima-specific Variables (Advanced)
+
+Since Colima is built on top of Lima, some advanced Lima variables can still be used for fine-tuning:
+
+### `LIMA_HOME`
+
+- **Description**: Specifies the Lima home directory (used by underlying Lima).
+- **Default**: `~/.lima`
+- **Usage**:
+  ```sh
+  export LIMA_HOME=~/.lima-custom
+  # Note: Colima manages Lima instances, so this is rarely needed
+  ```
+
+### `LIMA_INSTANCE`
+
+- **Description**: Used internally by Colima to manage Lima instances.
+- **Default**: Managed by Colima based on profile names
+- **Note**: Usually not set manually as Colima handles instance management.
+
+### `LIMA_INSTANCE`
+
+- **Description**: The underlying Lima instance name (managed by Colima).
+- **Set by**: Colima based on profile name
+- **Example**: `colima-default`, `colima-docker`
+
+## Legacy Lima Variables
+
+For advanced users who need to customize the underlying Lima behavior, some Lima environment variables are still respected. However, these should be used with caution as they may interfere with Colima's management:
+
+- `LIMA_HOME`: Lima home directory (impacts where Colima stores data)
+- Various QEMU and virtualization-specific settings

website/content/en/docs/config/mount.md

@@ -0,0 +1,4 @@
+---
+title: Filesystem mounts
+weight: 50
+---

website/content/en/docs/config/network/_index.md

@@ -0,0 +1,16 @@
+---
+title: Network
+weight: 30
+---
+
+See the following flowchart to choose the best network for you:
+```mermaid
+flowchart
+connect_to_vm_via{"Connect to the VM via"} -- "localhost" --> default["Default"]
+  connect_to_vm_via -- "IP" --> connect_from{"Connect to the VM IP from"}
+  connect_from -- "Host" --> vm{"VM type"}
+  vm -- "vz" --> vzNAT["vzNAT (see the VMNet page)"]
+  vm -- "qemu" --> shared["socket_vmnet (shared)"]
+  connect_from -- "Other VMs" --> userV2["user-v2"]
+  connect_from -- "Other hosts" --> bridged["socket_vmnet (bridged)"]
+```

website/content/en/docs/config/network/user-v2.md

@@ -0,0 +1,4 @@
+---
+title: user-v2 network
+weight: 32
+---

website/content/en/docs/config/network/user.md

@@ -0,0 +1,6 @@
+---
+title: Default user-mode network
+weight: 30
+
+---
+

website/content/en/docs/config/network/vmnet.md

@@ -0,0 +1,5 @@
+---
+title: VMNet networks
+weight: 33
+
+---

website/content/en/docs/config/port.md

@@ -0,0 +1,5 @@
+---
+title: Port Forwarding
+weight: 31
+---
+