Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Mac install instructions and add Docker instructions, from sylabs 8 #127

Merged
merged 2 commits into from
Jan 19, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -666,6 +666,20 @@ Install the following programs:
- `Vagrant for Windows <https://www.vagrantup.com/downloads.html>`_
- `Vagrant Manager for Windows <http://vagrantmanager.com/downloads/>`_

---
Mac
---

Singularity is available via Vagrant (installable with
`Homebrew <https://brew.sh>`_ or manually)

To use Vagrant via Homebrew:

.. code-block:: none

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
$ brew install --cask virtualbox vagrant vagrant-manager

-------------------------
{Singularity} Vagrant Box
-------------------------
Expand Down Expand Up @@ -706,3 +720,29 @@ You can check the installed version of {Singularity} with the following:

Of course, you can also start with a plain OS Vagrant box as a base and then
install {Singularity} using one of the above methods for Linux.

--------------------------
{Singularity} Docker Image
--------------------------

It is possible to use a Dockerized Singularity,
here is a sample ``compose.yaml`` (Singularity version 3.7.4) for use with Docker Compose:

.. code-block:: none

services:
singularity:
image: quay.io/singularity/singularity:v3.7.4-slim
stdin_open: true
tty: true
privileged: true
volumes:
- .:/root
entrypoint: ["/bin/sh"]

Singularity in Docker can have various disadvantages,
but basic container operations will work.
Currently, the intended use case is continuous integration,
meaning that you should be able to build a Singularity container using this Docker Compose file.
For more information see `issue#5 <https://github.com/sylabs/singularity-admindocs/issues/5#issuecomment-852307931>`_
and the image's source `repo <https://github.com/singularityhub/singularity-docker#use-cases>`_