1apptainer(1)                                                      apptainer(1)
2
3
4

NAME

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

SYNOPSIS

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

DESCRIPTION

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

OPTIONS

57       -c,  --config="/builddir/.apptainer/remote.yaml"       path to the file
58       holding remote endpoint configurations
59
60
61       -h, --help[=false]      help for remote
62
63
64

EXAMPLE

66                All group commands have their own help output:
67
68                  $ apptainer help remote list
69                  $ apptainer remote list
70
71
72
73

SEE ALSO

75       apptainer(1),    apptainer-remote-add(1),     apptainer-remote-add-key‐
76       server(1),   apptainer-remote-get-login-password(1),  apptainer-remote-
77       list(1),  apptainer-remote-login(1),  apptainer-remote-logout(1),  app‐
78       tainer-remote-remove(1),   apptainer-remote-remove-keyserver(1),   app‐
79       tainer-remote-status(1), apptainer-remote-use(1)
80
81
82

HISTORY

84       22-Nov-2023 Auto generated by spf13/cobra
85
86
87
88Auto generated by spf13/cobra      Nov 2023                       apptainer(1)