README document

OVERVIEW

Lima on Linux consists of one main executable lima which manages both Lima service and client.

The Lima service must be running in order to access the Lima drive from the local filesystem. Run lima start to launch it. The status of the service can be checked with the lima status command and stopped with lima stop.

The rest of the commands of the lima application provide a simple interface to setup Lima and control the filesystem.

OVERVIEW

FUSE

Lima requires FUSE to make its filesystem available to the user. In most cases, this requires the installation of a package called 'libfuse2' or 'fuse-libs' as well as having the file /etc/fuse.conf readable by the current user.

The DEB and RPM packages have libfuse2 as an explicit dependency that should be installed automatically by your package manager.

On many Linux distributions the file /etc/fuse.conf is not readable by the users, in which case the most reliable and secure solution is to add user into the group that owns /etc/fuse.conf. For example, if /etc/fuse.conf is owned by the fusegroup (check with the stat -c '%G' /etc/fuse.conf shell command), you should add the current user into the fuse group by running the shell command sudo gpasswd -a $USER fuse.

IMPORTANT: the user must relogin to apply these changes!

Keyring

The Lima Linux client currently supports Gnome Keyring and KWallet. This is an optional dependency and is activated only if the appropriate services python bindings are available. If both are available, Gnome Keyring has precedence.

Required packages for Gnome Keyring

  • Debian-based distributions: python-gnomekeyring
  • Fedora: gnome-python2-gnomekeyring
  • OpenSUSE: python-gnomekeyring
  • Arch Linux: python2-gnomekeyring

Required packages for KWallet

  • Debian-based distributions: python-kde4
  • Fedora: pykde4
  • OpenSUSE: python-kde4
  • Arch Linux: kdebindings-python2

Firewall

If you have a firewall on your Linux machine, make sure:

  • the Lima service can open outbound TCP connections to anywhere;
  • the Lima service can listen on TCP port 25211;
  • the Lima service can listen on UDP ports 25213 and 33612.

For instance, if you use ufw, this should be enough:

ufw allow 25211/tcp # normal network communication port
ufw allow 25213/udp # used to detect devices on the same LAN
ufw allow 33612/udp # used to detect Limas during setup

INITIAL SETUP

Ensure that all prerequisites are satisfied and launch the Lima service with lima start.

Once Lima is successfully launched, proceed with the initial setup by running lima setup. You will be guided through the setup process to create or connect to your Lima account, discover your Lima device and attach it to your account.

METADATA WORKER

Metadata worker is a Lima service responsible for the generation of the thumbnails of the media files stored on Lima. It depends on ffmpeg and libjpeg-turbo8 packages which are available on the most of the distributions.

Fedora

Fedora is known to omit ffmpeg and libjpeg8 from their official repositories. Thereby user should add external package repository rpmfusion for ffmpeg. And install libjpeg8 manually from rpmfind

Ubuntu 14.04

Ubuntu 14.04 doesn't include ffmpeg in their repositories. It's required to add external package repository as described on faqforge.

Uninstalling

To remove all user data created by the Lima application, run lima uninstall. Note that if you do this you will permanently lose all the files that have not been uploaded to your Lima yet.

Once this is done, you can uninstall Lima using your package manager if you have used one to install it.

USAGE

During the initial setup the client is automatically logged in. In all other cases a manual login is required with the lima logincommand on each Lima service launch unless the credentials were stored in the system keyring during setup. The Lima filesystem becomes available only after successful authentication.

To get the list of available commands, run lima with no arguments or lima help. To get help about an individual command, run lima help <command>.

By default the Lima filesystem is mounted at ~/Lima.

Files kept available locally

In general, when you add a file into your Lima drive, it is copied into a local cache and asynchronously uploaded to your Lima device. Once the file is fully uploaded onto the device, the local client can decide to purge its data from the local cache if it needs the space. This allows you to have, for instance, 2 TB of files inside Lima but still access them from a machine with a 128 GB hard drive.

However, you may want to keep a subset of your files available locally on a device, i.e. never purge them from the cache. You will then be guaranteed that those files can be open, even if your client device cannot contact the Lima. To do so, you can use the lima pin and lima unpin commands, which respectively set and unset the "pinned flag". Files with the pinned flag will never be purged from the cache. Moreover, if you set the pinned flag on a file which is not available in the cache, Lima will download it.

Note that you if you call lima pin or lima unpin on a directory, it will have the same effect as calling it recursively on the content of this directory. Those commands have no effect on symbolic links.

ls

lima ls show the advanced filesystem view and extends the traditional ls command with the following fields:

-rw-r--r--  110.96 KiB  (0%)  [APELBO]  leeks_1024x768.jpg
                        \__/  \______/
                          \      \--------- File Flags
                           \--------------- Local Availability
  • Local Availability: Percentage of the file or directory content that is stored in the local filesystem cache. If you make a file available offline by using the lima pin command, this percentage will grow to 100% while the file is downloaded from your Lima device(s) or from other Lima clients.
  • 'A' Available flag: The file content is available, either from a cached local copy or from another Lima client that is visible on the network. If this flag is not set, opening the file will fail with a 'Data Not Available' error.
  • 'P' Pinned flag: The file was marked as available offline by using the lima pin command. The file content should be available locally or be in the process of being downloaded. See Local Availability above.
  • 'E' Error flag: The file is not available due to an internal error state.
  • 'L' Lima flag: The file was uploaded successfully to the Lima and is stored on its hard drive.
  • 'B' Backed up flag: The file was successfully backed up by more than one Lima.
  • 'O' Original Creator flag: The file originates from this computer, i.e. it was originally created or copied onto the Lima Drive from this system.
Submit a request
Powered by Zendesk