1singularity(1)                                                  singularity(1)
2
3
4

NAME

6       singularity-remote  -  Manage  singularity remote endpoints, keyservers
7       and OCI/Docker registry credentials
8
9
10

SYNOPSIS

12       singularity remote [remote options...]
13
14
15

DESCRIPTION

17       The 'remote' command allows you to manage Singularity remote endpoints,
18         standalone keyservers and OCI/Docker registry credentials through its
19         subcommands.
20
21
22       A 'remote endpoint' is the Sylabs Cloud, a Singularity  Enterprise  in‐
23       stallation,
24         or  a  compatible  group of services. The remote endpoint is a single
25       address,
26         e.g. 'cloud.sylabs.io' through which linked library, builder and key‐
27       store
28         sevices will be automatically discovered.
29
30
31       To  configure  a remote endpoint you must 'remote add' it. You can 're‐
32       mote login' if
33         you will be performing actions needing authentication. Switch between
34         configured remote endpoints with the 'remote use' command. The active
35       remote
36         endpoint  will  be  used  for remote builds, key operations, and 'li‐
37       brary://' pull
38         and push. You can also 'remote logout' from and  'remote  remove'  an
39       endpoint that
40         is no longer required.
41
42
43       To  configure  credentials  for OCI registries that should be used when
44       pulling or
45         pushing from/to 'docker://'' or 'oras://' URIs, use the  'remote  lo‐
46       gin' command
47         only.  You do not have to 'remote add' OCI registries. To remove cre‐
48       dentials
49         'remote logout' with the same URI. You do not need to 'remote remove'
50       OCI
51         credentials.
52
53
54       The  remote  configuration is stored in $HOME/.singularity/remotes.yaml
55       by default.
56
57
58

OPTIONS

60       -c, --config="/builddir/.singularity/remote.yaml"      path to the file
61       holding remote endpoint configurations
62
63
64       -h, --help[=false]      help for remote
65
66
67

EXAMPLE

69                All group commands have their own help output:
70
71                  $ singularity help remote list
72                  $ singularity remote list
73
74
75
76

SEE ALSO

78       singularity(1),  singularity-remote-add(1), singularity-remote-add-key‐
79       server(1),  singularity-remote-get-login-password(1),   singularity-re‐
80       mote-list(1),    singularity-remote-login(1),    singularity-remote-lo‐
81       gout(1),  singularity-remote-remove(1),  singularity-remote-remove-key‐
82       server(1), singularity-remote-status(1), singularity-remote-use(1)
83
84
85

HISTORY

87       18-Sep-2023 Auto generated by spf13/cobra
88
89
90
91Auto generated by spf13/cobra      Sep 2023                     singularity(1)