Skip to content

Setup an object storage client

To install thes3cmdclient you can follow the steps in the official installation guide.

After the installation you can run the following command to ensure the client is installed correctly:

Terminal window
s3cmd --version

You should receive back output with the version of installed client. This guide is based on the version 2.2.0.

In order to use the s3cmd you need to specify the settings to interact with your Object Storage Service. The client supports you with configuration wizard.

Run the following command to launch an interactive form.

Terminal window
s3cmd --configure

It will ask you for the following information:

After defining all parameters, the new settings will be presented to you. If they look correct you can test it by enteringY.

Terminal window
Access Key:
Secret Key:
Default Region [US]:
S3 Endpoint: object.storage.eu01.onstackit.cloud
DNS-style bucket+hostname:port template for accessing a bucket: object.storage.eu01.onstackit.cloud/%(bucket)
Encryption password:
Path to GPG program [/opt/homebrew/bin/gpg]:
Use HTTPS protocol[Yes]:
True HTTP Proxy server name:
HTTP Proxy server port: 0
Test access with supplied credentials? [Y/n] y

Configure your client: save your configuration

Section titled “Configure your client: save your configuration”

If the test was successful, you should see this output. You can save the new configuration by entering y.

Terminal window
Please wait, attempting to list all buckets...
Success. Your access key and secret key worked fine :-)
Now verifying that encryption works...
Not configured. Never mind.
Save settings? [y/N] y
Configuration saved to '/Users/user/.s3cfg'

Now your client is successfully configured and can be used to manage your Object Storage Service. The created configuration files is named.s3cfgand is stored in your home directory.

You can add / modify options if needed on the.s3cfg file. For a list of all available parameters on the.s3cfg see the official documentation