Skip to content

Commit

Permalink
feat: add CyberDuck integration docs (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
kmushegi committed May 12, 2023
1 parent 97829ed commit 1f09f9f
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 2 deletions.
39 changes: 39 additions & 0 deletions integrations/cyberduck/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# CyberDuck integration

This guide will walk you through how to seamlessly integrate SideKick with your CyberDuck instance running on your machine.

## SideKick configuration

To get started, you will need to run SideKick on your machine. Head over to the [releases page](https://github.com/project-n-oss/sidekick/releases) and download the package for your OS and architecture.

Next, extract the binary from the downloaded file:

**macOS**
```bash
tar -xvf <artifact>.tar.gz
```

**Windows**
Right-click on the downloaded file in the File Explorer and click "Extract All".

Before running the executable, make sure the following environment variables are set:

* `BOLT_CUSTOM_DOMAIN`: This is the custom domain you chose during setup.
* `AWS_REGION`: This is the region of your Bolt deployment.

**macOS**

```bash
export BOLT_CUSTOM_DOMAIN="your-custom-domain.com"
export AWS_REGION="your-bolt-region"
```

**Windows**
```bash
set BOLT_CUSTOM_DOMAIN=your-bolt-domain.com
set AWS_REGION=your-bolt-region
```

## CyberDuck configuration

Now that you have SideKick running, download the SideKick CyberDuck bookmark file from [here](./sidekick.duck). Drag it onto your CyberDuck window and enter your AWS credentials.
18 changes: 18 additions & 0 deletions integrations/cyberduck/sidekick.duck
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Protocol</key>
<string>s3</string>
<key>Provider</key>
<string>s3-http</string>
<key>Nickname</key>
<string>SideKick</string>
<key>UUID</key>
<string>a4a82250-3ea9-4353-b0e0-525f12e7810e</string>
<key>Hostname</key>
<string>localhost</string>
<key>Port</key>
<string>7075</string>
</dict>
</plist>
4 changes: 2 additions & 2 deletions integrations/kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ To get started, you will need to configure your SideKick sidecar container. A sa

Additionally, the following environment variables must be set:

* BOLT_CUSTOM_DOMAIN: This is the custom domain you chose during setup.
* AWS_REGION: This is the region of your Bolt deployment.
* `BOLT_CUSTOM_DOMAIN`: This is the custom domain you chose during setup.
* `AWS_REGION`: This is the region of your Bolt deployment.


## Application configuration
Expand Down

0 comments on commit 1f09f9f

Please sign in to comment.