Skip to content
This repository has been archived by the owner on Mar 6, 2024. It is now read-only.

Latest commit

 

History

History
67 lines (43 loc) · 2.51 KB

README.orig.rst

File metadata and controls

67 lines (43 loc) · 2.51 KB
Raw

Coverage

Wildland Client

Wildland is a collection of protocols, conventions, software, and (soon) a marketplace for leasing storage and -- in the future -- compute infrastructure. All these pieces work together with one goal in mind: to decouple the user's data from the underlying infrastructure.

This repository contains Wildland Client software - the part used to access data stored with Wildland and serve them as a (FUSE based) filesystem. It also allows to manage Wildland Containers.

More information can be found in the documentation

The primary location of the source code is at gitlab.com <https://gitlab.com/wildland/wildland-client>. Please use this location for contributing (reporing issues, contributing code etc).

Quick start

Currently the primary method of running wildland-client, is to use bundled docker image:

./wildland-docker.sh

Alternatively, run the docker-compose directly:

docker-compose run --service-ports wildland-client

This container serves FUSE content as WebDAV too.

See Setup for more.

Repository structure

  • Documentation/: project documentation, in ReST/Sphinx format
  • ci/: Docker setup for CI
  • docker/: Docker setup for local testing
  • wl, wildland-cli: command-line interface entry point
  • wildland-fuse: FUSE driver entry point
  • plugins/: storage backends source code, at some point to be removed from Wildland's core
  • wildland/: Python source code
    • wildland/schemas/: Manifest schemas in JSON Schema format
    • wildland/tests/: Tests (in Pytest framework)

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

See COPYING file for the full license text.

In order to be able to contribute to any Wildland repository, you will need to agree to the terms of the Wildland Contributor Agreement. By contributing to any such repository, you agree that your contributions will be licensed under the GPLv3 License.