# MacOS

# Install Docker

Using the Homebrew package manager (if you don't have Homebrew, install it following the steps described on their home page (opens new window)):

% brew install --cask docker

Launch the Docker.app and let it finish the installation.

# Clone Wildland repository

% git clone -b stable https://gitlab.com/wildland/wildland-client.git

# Build and start Docker image

% cd wildland-client/docker
% docker-compose build
% docker-compose run --service-ports wildland-client

This will start the Wildland terminal session through which you can interact with Wildland client using the wl command.

To connect to the Wildland filesystem using Finder, select Connect to Server from Go menu and type http://localhost:8080 as the server address. If you get a warning about an insecure connection, just choose to connect and select "Connect as Guest" when asked for a password.

Once you have completed all of these steps, head over to the Quick Start Guide and follow the instructions there.

# Run Wildland macOS client

WARNING

Wildland macOS client is under active development and has not received a lot of testing yet. Use it only if you are prepared to encounter some bugs, and willing to risk losing your data.

Currently macOS client does not provide any real GUI frontend. The only way to interact with Wildland is through the command line interface.

# Cloning

Clone the macOS client from the project's GitLab repository (opens new window):

% git clone https://gitlab.com/wildland/wildland-client-macos.git

# Building

WARNING

Currently the build process works only on Mac desktops with Intel chips.

First of all, make sure that you checked out all the dependencies in source form:

git submodule update --init

and in binary form:

brew install signify-osx autoconf autogen automake

This project currently uses the following dependencies:

  • Python: cpython 3.9.2
  • OpenSSL: 1.1.1i
  • xz: 5.2.5
  • wildland-client: closely tracking project stable HEAD

The Xcode project is currently configured to embed all the above-mentioned dependencies into the application bundle.

Python and OpenSSL are built from source, which means that:

  • fresh build can take some time,
  • if you encounter any problems, the first thing to do is to clean the build directory.

Building using Xcode should be straightforward: just open WildandClient xcode project, make sure that WildlandClient target is selected and press Cmd+B.

Building from the command line:

cd WildlandClient
xcodebuild -scheme WildlandClient OBJROOT=/tmp/wl-build SYMROOT=/tmp/wl-products

should build the project and put the resulting artifacts in /tmp/wl-products.

# Obtaining binary form

As an alternative to building from source a binary snapshots can be obtained from the CI (opens new window). Look for Download archive_project:archive_artifact in successful builds. Note that builds are not signed with distribution certfiicates and are not submitted to Apple notarization process. Use them at your own risk.

# Installing

Copy WildlandClient.app to your /Applications folder.

You start the client by opening WildlandClient.app. This installs the daemon which will create the mount point for Wildland. The daemon will launch automatically once you log in.

WildlandClient

# Using

# First launch

You start by double-clicking on WildlandClient app. When you do this for the first time you need to allow it in Privacy Settings.

Security warning

Allowing Wildland to start

You will be also prompted for administrator password to install the helper tool. When Wildland is properly started, it automatically mounts its volume so it is available in Finder.

During the launch you will be asked whether to create a link for command line interface in your /usr/local/bin directory.

First launch

# Normal usage

Do not expect any real functionality from GUI interface. Most of your interaction with Wildland will happen through the command line interface.

If you allowed Wildland to create symlink in /user/local/bin,you can interact with Wildland by typing wl on the terminal. Otherwise the command line interface is available at:

/Applications/WildlandClient.app/Contents/MacOS/wl-cli

See Quick Start Guide for details on how to use the CLI.

# Stopping Wildland

Wildland will normally configure itself to launch automatically on login. When desired you can stop Wildland for current session by ejecting it in Finder, or selecting Stop Wildland from Wildland menu.

Wildland menu

# Uninstalling

To deregister Wildland service so that it doesn't start automatically open the GUI tool and select Terminate Wildland and disable service command from Client menu.

You can then just move WildlandClient.app to Trash.