> ## Documentation Index
> Fetch the complete documentation index at: https://docs.scitix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Configure ossctl

> Learn how to obtain Access Keys, download, and configure ossctl.

ossctl is the official S3 protocol command-line tool provided by ScitiX. After configuration, you can use the command line to upload, download, and list objects in OSS Buckets.

## Pre-Operation Confirmation

* The OSS bucket (Bucket) to be accessed has been created, and you have obtained permission to access it.
* The current environment can access the OSS Endpoint in the Region where the bucket is located.

## Obtain an Endpoint

1. Log in to the [GPU Cloud console](https://console.scitix.ai/gpu-cloud/home).

2. Go to **STORAGE > Object Storage**.

3. In the upper-right corner, select the Region where the bucket is located.

4. On the **Buckets** tab, copy the **Endpoint** displayed above the list.

   Different regions use different endpoints. When configuring ossctl, use the endpoint corresponding to the region where the bucket is located.

## Obtain Access Keys

1. Go to the **STORAGE > Object Storage** page.

2. Click the **Access Keys** tab, and then create an access key.

3. Configure the Access Keys parameters, then submit.

   | Parameter | Description |
   | - | - |
   | **Access Key** | The system-generated access key ID. |
   | **Secret Key** | The system-generated access key secret. |
   | **Expiration Time** | The expiration time of the access key. |
   | **Name** | The access key name, used to distinguish keys for different purposes. |
   | **Description** | A description of the access key. You can specify the usage scenario or management notes. |

4. Save the generated Access Key and Secret Key.

> [!WARNING]
>
> The Secret Key is used only for access authentication. Keep it secure, and do not transmit it through public channels or write it to Logs.

## Download ossctl

Download ossctl for your local OS.

### Windows Download

```bash theme={null}
curl -LO https://oss-ap-southeast.scitix.ai/scitix/packages/ossctl/latest/windows-amd64/ossctl.exe
```

### Linux amd64 Download

```bash theme={null}
curl -LO https://oss-ap-southeast.scitix.ai/scitix/packages/ossctl/latest/linux-amd64/ossctl
```

### macOS amd64 Download

```bash theme={null}
curl -LO https://oss-ap-southeast.scitix.ai/scitix/packages/ossctl/latest/darwin-amd64/ossctl
```

### macOS arm64 Download

```bash theme={null}
curl -LO https://oss-ap-southeast.scitix.ai/scitix/packages/ossctl/latest/darwin-arm64/ossctl
```

## Configure OSS

After the download is complete, add the OSS access configuration based on the OS.

### Configure Linux or macOS

```bash theme={null}
chmod +x ossctl
./ossctl config add <CONFIGNAME> <ENDPOINT> <ACCESSKEY> <SECRETKEY>
```

### Windows Configuration

```powershell theme={null}
.\ossctl.exe config add <CONFIGNAME> <ENDPOINT> <ACCESSKEY> <SECRETKEY>
```

### Parameter Description

| Parameter | Description |
| - | - |
| `<CONFIGNAME>` | The name of the local OSS access configuration. You can replace it with a custom name as needed. |
| `<ENDPOINT>` | The OSS access endpoint for the region where the bucket is located. |
| `<ACCESSKEY>` | The Access Key in the access keys. |
| `<SECRETKEY>` | The Secret Key in the access keys. |

## Verify Configuration

After configuration is complete, you can list the objects in the authorized Buckets to verify that ossctl is available.

```bash theme={null}
./ossctl ls <CONFIGNAME>/<BUCKET>
```

Where:

* `<CONFIGNAME>` is the name of the local OSS access configuration.
* `<BUCKET>` is the name of the authorized Bucket.

If command execution fails, first check the endpoint, access keys, configuration name, bucket permissions, and network connectivity. If the issue persists, record the error information and contact technical support.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.