diff --git a/source/assets/troubleshooting/dd_default_disk_size.png b/source/assets/troubleshooting/dd_default_disk_size.png new file mode 100644 index 0000000..f3f15fd Binary files /dev/null and b/source/assets/troubleshooting/dd_default_disk_size.png differ diff --git a/source/assets/troubleshooting/dd_shrink.png b/source/assets/troubleshooting/dd_shrink.png new file mode 100644 index 0000000..93d1cc0 Binary files /dev/null and b/source/assets/troubleshooting/dd_shrink.png differ diff --git a/source/community/contributors.rst b/source/community/contributors.rst index 3acef23..20a1854 100644 --- a/source/community/contributors.rst +++ b/source/community/contributors.rst @@ -106,6 +106,9 @@ When installing a tool, depending on how it gets installed, here are the rules. * Most tools are installed either in their own directory in ``/opt/tools/`` or have the binary (or a symlink) in ``/opt/tools/bin/``. * Disk space being limited, we're not pulling every code source around. When possible, add the ``--depth 1`` option to your usual ``git clone`` command. +To manage tool versions, we use ``asdf`` (`asdf-vm/asdf `_), a version management tool that allows the installation and management of multiple versions of various programming languages and tools across different projects. ``asdf`` uses a system of shims to ensure that the correct version of a tool is used based on your project's configuration. Currently, on Exegol, asdf only manages the ``Go`` programming language (``golang``). + + .. tabs:: .. tab:: Python sources (pipx) @@ -153,8 +156,14 @@ When installing a tool, depending on how it gets installed, here are the rules. The package you want to install needs to be added there, along with the ``add-history``, ``add-test-command`` and ``add-to-list`` instructions. .. tab:: Go + If you choose to install a new golang tool in your container using the ``go install -v github.com/AUTHOR/REPO@latest`` command, you will need to follow it up with the ``asdf reshim golang`` command. This additional step is necessary for asdf to recognize and integrate the newly installed tool into the environment. + + .. code-block:: bash + + go install -v github.com/patrickhener/goshs@latest + asdf reshim golang + goshs --help - Go tools can be installed with a standard ``go install -v github.com/AUTHOR/REPO@latest`` command. .. tab:: Ruby diff --git a/source/community/sponsors.rst b/source/community/sponsors.rst index 13a0567..c90de1d 100644 --- a/source/community/sponsors.rst +++ b/source/community/sponsors.rst @@ -2,27 +2,6 @@ Sponsors ======== -.. image:: /assets/sponsors/capgemini.png - :align: center - :width: 300px - :alt: Capgemini logo - -| - -Dramelac and I work at `Capgemini `_ and we thank them for believing in the project since day 1, and for allowing us to have this personal initiative keep going. - -| - -.. image:: /assets/sponsors/hackthebox.png - :align: center - :width: 300px - :alt: HackTheBox logo - -| - -We thank **HackTheBox** for continuously supporting the community and for helping us financially to acquire the necessary hardware for supporting multiple architectures (AMD64, ARM64). Show some love at https://www.hackthebox.com/ ! - - .. image:: https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png :align: center :width: 200px diff --git a/source/getting-started/install.rst b/source/getting-started/install.rst index 18bb406..1497842 100644 --- a/source/getting-started/install.rst +++ b/source/getting-started/install.rst @@ -92,6 +92,8 @@ Additional dependencies may be required depending on the host OS. If you install Exegol from the python pip package, this folder is located where the python packages are installed. The path to this folder depends on how you installed python. When creating your first container, you may get an error disclosing the exegol installation folder, which will have to be added as an authorized resource. + By default, you can try to add the path: ``/Library/Frameworks/Python.framework`` to the Docker Desktop File sharing allowlist. + .. tip:: diff --git a/source/getting-started/troubleshooting.rst b/source/getting-started/troubleshooting.rst index e49789e..c948043 100644 --- a/source/getting-started/troubleshooting.rst +++ b/source/getting-started/troubleshooting.rst @@ -70,6 +70,34 @@ Docker image downloads may be time-sensitive. In the case of dual-boot systems, To correct the problem, check that your computer's date and time are correct. +How to fix ``Docker download error: no space left on device`` +============================================================= + +``Docker Desktop`` is a tool used for running Docker containers on ``Windows`` and ``macOS``. However, it uses a ``virtual disk`` to store Docker images, containers, and volumes. The virtual disk used by Docker Desktop is not dynamic; it has a fixed size, which by default is set to ``64GB``. + +.. image:: /assets/troubleshooting/dd_default_disk_size.png + :align: center + :alt: Docker Desktop default disk size + +.. raw:: html + +
+ +Exegol images can be quite large, with some reaching over ``50GB``. This can quickly exceed the available virtual disk space, even if your physical disk still has free space. To resolve this issue, you need to allocate more space to the Docker Desktop virtual disk. + +To increase the ``virtual disk size``, open Docker Desktop and go to ``Settings -> Resources -> Advanced``. Locate the ``Virtual disk limit`` option and increase the allocated size. Make sure to choose a value that provides enough space for your images and containers, such as ``128GB`` or more depending on your needs. + +Apply the changes and then ``restart`` Docker Desktop to ensure the new configuration takes effect. + +.. warning:: + + If you decide to ``reduce the size of the virtual disk``, be aware that Docker Desktop will completely ``delete the virtual disk image``. This action will remove all Docker images, containers, and volumes stored on the disk. Therefore, before reducing the disk size, make sure to back up any important data or export your Docker images to avoid data loss. + + .. image:: /assets/troubleshooting/dd_shrink.png + :align: center + :alt: Docker Desktop shrink disk image + + How to fix CRLF errors on Windows =================================