Skip to content

Latest commit

 

History

History
181 lines (141 loc) · 7.37 KB

README.md

File metadata and controls

181 lines (141 loc) · 7.37 KB
Raw

Cyberduck

GitHub commit GitHub license Build Status Twitter

This is the development home for Cyberduck, a libre file transfer client for macOS and Windows. Command line interface (CLI) for Linux, macOS and Windows. The core libraries are used in Mountain Duck.

Cyberduck Icon

Mailing Lists

There is a Google Groups Cyberduck discussion mailing list.

The following additional mailing lists are hosted:

  • News Announcements of new releases
  • Localization Notifications about changes to the translations needed

Source

Source code is available licenced unter the GNU General Public Licence Version 3. Pull requests welcome!

Localizations

Translations to new languages are welcome. We use Transifex to localize resources. Current available localizations are English, Czech, Dutch, Finnish, French, German, Italian, Japanese, Korean, Norwegian, Portuguese, Slovak, Spanish, Chinese (Traditional & Simplified Han), Russian, Swedish, Hungarian, Danish, Polish, Indonesian, Catalan, Welsh, Thai, Turkish, Hebrew, Latvian, Greek, Serbian, Georgian and Slovenian.

Make sure to subscribe to the localization mailing list.

Support & Documentation

For general help about using Cyberduck, please refer to the documentation.

Snapshot and Beta builds

These are nightly snapshot builds from the current development trunk featuring the latest bugfixes and enhancements. Be warned, tough, these builds are potentially unstable and experimental. You can also switch to beta or snapshot builds in _Preferences → Update.

Prerequisites

  • Java 11 SDK or later
  • Apache Ant 1.10.1 or later
  • Apache Maven 3.5 or later

macOS

Windows

Chocolatey

choco install adoptopenjdk15 maven bonjour -y
choco install visualstudio2019buildtools -y
choco install wixtoolset -y
choco install visualstudio2019-workload-manageddesktopbuildtools --params "--add Microsoft.Net.Component.4.7.TargetingPack" -y
choco install visualstudio2019-workload-netcorebuildtools -y
choco install visualstudio2019-workload-vctools --params "--add Microsoft.VisualStudio.Component.Windows10SDK.17763 --add Microsoft.VisualStudio.Component.VC.v141.x86.x64" -y

Restart your machine after installing these components.

Additional %PATH%:

  • %ProgramFiles(x86)%\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin
  • %ProgramFiles(x86)%\Windows Kits\10\bin\10.0.17763.0\x64

Building

Run mvn verify -DskipTests -DskipSign to build without running any tests and skip codesign. Find build artifacts in

  • osx/target/Cyberduck.app
  • windows/target/Cyberduck.exe

Run with -Pinstaller to build installer packages with build artifacts

  • osx/target/release/*.(zip|pkg)
  • windows/target/release/*.(exe|msi)
  • cli/osx/target/release/*.(pkg|tar.gz)
  • cli/windows/target/release/*.(exe|msi)
  • cli/linux/target/release/*.(deb|rpm)

Windows

You will run into warnings from MSBuild/WiX that are unrelated to how Cyberduck is built. You may safely ignore them.

Debugging

macOS

Edit setup/app/Info.plist if you want to debug Cyberduck.app or setup/pkg/Info.plist if you want to debugduck respectively. Add -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 to allow to connect to the running application in your IDE by attaching to the remote JVM.

Windows

Due to Visual Studio not being able to handle Java projects it is required to follow these steps for debugging:

  • Run mvn verify -Dconfiguration=debug which ensures that debugging symbols are generated This prevents Visual Studio (or `MSBuild invoked from Maven) from generating optimized assemblies which in turn may prevent debugging.

  • Open the solution in Visual Studio

  • Open a .java file and set a break point. Visual Studio breaks either on or near the line selected.

  • Debugging capabilities include

    • Step Over
    • Step Into
    • Step Out
    • Continue
    • Local/Auto variables
    • Immediate Window

    Go To Symbol is not working due to missing Java support.

Running Tests

After packaging, run mvn test -DskipITs to run unit tests but skip integration tests.

Maven Artifacts (GPL)

Repository Configuration

Maven artifacts are available in a repository hosted on Amazon S3.

  • Use the following Maven configuration in your project POM to reference artifacts from Cyberduck
<repositories>
   <repository>
       <id>maven.cyberduck.io-release</id>
       <url>http://repo.maven.cyberduck.io.s3.amazonaws.com/releases/</url>
       <layout>default</layout>
       <releases>
           <enabled>true</enabled>
       </releases>
       <snapshots>
           <enabled>false</enabled>
       </snapshots>
   </repository>
</repositories>
  • You will need to add the AWS Maven Wagon to your build using
<build>
    <extensions>
        <extension>
            <groupId>org.springframework.build</groupId>
            <artifactId>aws-maven</artifactId>
            <version>5.0.0.RELEASE</version>
        </extension>
    </extensions>
</build>

Artifacts

  • Protocol implementations
<dependency>
    <groupId>ch.cyberduck</groupId>
    <artifactId>protocols</artifactId>
    <type>pom</type>
    <version>7.1.0</version>
</dependency>
  • Cocoa Java Bindings (macOS)
<dependency>
    <groupId>ch.cyberduck</groupId>
    <artifactId>binding</artifactId>
    <version>7.1.0</version>
</dependency>
  • Implementations (macOS) using Launch Services, SystemConfiguration, Foundation, Keychain and other API
<dependency>
    <groupId>ch.cyberduck</groupId>
    <artifactId>libcore</artifactId>
    <version>${project.version}</version>
</dependency>

Sponsors

YourKit

YourKit supports open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.