apptainer remote

Manage apptainer remote endpoints


The ‘remote’ command allows you to manage Apptainer remote endpoints through its subcommands.

A ‘remote endpoint’ is a group of services that is compatible with the container library API. The remote endpoint is a single address, e.g. ‘’ through which library and/or keystore services will be automatically discovered.

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 key operations, and ‘library://’ pull and push. You can also ‘remote logout’ from and ‘remote remove’ an endpoint that is no longer required.

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


All group commands have their own help output:

  $ apptainer help remote list
  $ apptainer remote list


-c, --config string   path to the file holding remote endpoint configurations (default "/home/runner/.apptainer/remote.yaml")
-h, --help            help for remote


Linux container platform optimized for High Performance Computing (HPC) and Enterprise Performance Computing (EPC) * apptainer remote add - Add a new apptainer remote endpoint * apptainer remote get-login-password - Retrieves the cli secret for the current logged in user * apptainer remote list - List all apptainer remote endpoints that are configured * apptainer remote login - Login to an apptainer remote endpoint * apptainer remote logout - Log out from an apptainer remote endpoint * apptainer remote remove - Remove an existing apptainer remote endpoint * apptainer remote status - Check the status of the apptainer services at an endpoint, and your authentication token * apptainer remote use - Set an Apptainer remote endpoint to be actively used

Auto generated by spf13/cobra on 25-Apr-2024