.nh
.TH "singularity" "1" "Feb 2023" "Auto generated by spf13/cobra" ""

.SH NAME
.PP
singularity-remote - Manage singularity remote endpoints, keyservers and OCI/Docker registry credentials


.SH SYNOPSIS
.PP
\fBsingularity remote [remote options...]\fP


.SH DESCRIPTION
.PP
The 'remote' command allows you to manage Singularity remote endpoints,
  standalone keyservers and OCI/Docker registry credentials through its
  subcommands.

.PP
A 'remote endpoint' is the Sylabs Cloud, a Singularity Enterprise installation,
  or a compatible group of services. The remote endpoint is a single address,
  e.g. 'cloud.sylabs.io' through which linked library, builder and keystore
  sevices will be automatically discovered.

.PP
To configure a remote endpoint you must 'remote add' it. You can 'remote login' if
  you will be performing actions needing authentication. Switch between
  configured remote endpoints with the 'remote use' command. The active remote
  endpoint will be used for remote builds, key operations, and 'library://' pull
  and push. You can also 'remote logout' from and 'remote remove' an endpoint that
  is no longer required.

.PP
To configure credentials for OCI registries that should be used when pulling or
  pushing from/to 'docker://'' or 'oras://' URIs, use the 'remote login' command
  only. You do not have to 'remote add' OCI registries. To remove credentials
  'remote logout' with the same URI. You do not need to 'remote remove' OCI
  credentials.

.PP
The remote configuration is stored in $HOME/.singularity/remotes.yaml by default.


.SH OPTIONS
.PP
\fB-c\fP, \fB--config\fP="/home/buildd/.singularity/remote.yaml"
	path to the file holding remote endpoint configurations

.PP
\fB-h\fP, \fB--help\fP[=false]
	help for remote


.SH EXAMPLE
.PP
.RS

.nf

  All group commands have their own help output:

    $ singularity help remote list
    $ singularity remote list

.fi
.RE


.SH SEE ALSO
.PP
\fBsingularity(1)\fP, \fBsingularity-remote-add(1)\fP, \fBsingularity-remote-add-keyserver(1)\fP, \fBsingularity-remote-list(1)\fP, \fBsingularity-remote-login(1)\fP, \fBsingularity-remote-logout(1)\fP, \fBsingularity-remote-remove(1)\fP, \fBsingularity-remote-remove-keyserver(1)\fP, \fBsingularity-remote-status(1)\fP, \fBsingularity-remote-use(1)\fP


.SH HISTORY
.PP
13-Feb-2023 Auto generated by spf13/cobra