github.com/dctrud/umoci@v0.4.3-0.20191016193643-05a1d37de015/doc/site/_index.md (about)

     1  +++
     2  title = "Home"
     3  +++
     4  
     5  [![umoci](/umoci-black.png)](/)
     6  
     7  Made with ❤ by [openSUSE][openSUSE].
     8  
     9  umoci is a free software tool for manipulating and interacting with container
    10  images in the standardised [Open Container Initiative's][oci] image format. It
    11  provides one of the most flexible image management toolsets, requiring neither
    12  a daemon nor any particular filesystem setup. It is already used in a variety
    13  of different projects and by several companies.
    14  
    15  [openSUSE]: https://opensuse.org/
    16  [oci]: https://www.opencontainers.org/
    17  
    18  ### Features ###
    19  
    20  umoci's feature set is intentionally restricted, as it has well-defined goals.
    21  
    22  * Extraction of images produces a standardised [OCI runtime
    23    bundle][oci-runtime], which is immediately usable by [runc][runc] or [any
    24    other OCI-compliant runtime][oci-runtimes]. However, these bundles are also
    25    usable without the need for containers (which means that builders can mutate
    26    the root filesystem in whatever fashion they choose).
    27  * Generates delta layers without requiring filesystem-specific features.
    28    Rather, it makes use of existing [mtree][mtree(8)] manifest tooling to
    29    compute the deltas of paths in the root filesystem.
    30  * Supports [rootless containers][rootless] natively, both by allowing for
    31    extraction of layers that would normally require privileges and by generating
    32    runtime configurations that `runc` can use as an unprivileged user.
    33  * Internal libraries are entirely built around a generic content addressable
    34    store interface, allowing for code reuse by other projects and the
    35    possibility for new backends.
    36  
    37  [mtree(8)]: https://www.freebsd.org/cgi/man.cgi?mtree(8)
    38  [oci-runtime]: https://github.com/opencontainers/runtime-spec
    39  [runc]: https://github.com/opencontainers/runc
    40  [oci-runtimes]: https://github.com/opencontainers/runtime-spec/blob/v1.0.0/implementations.md
    41  [rootless]: https://rootlesscontaine.rs/
    42  
    43  ### Install ###
    44  
    45  Pre-built binaries can be downloaded from [umoci's releases page][releases]. As
    46  umoci's builds are reproducible, a cryptographic checksum file is included in
    47  the release assets. All of the assets are also signed with a [release
    48  key][umoci-keyring].
    49  
    50  ```text
    51  pub   rsa4096 2016-06-21 [SC] [expires: 2031-06-18]
    52        5F36C6C61B5460124A75F5A69E18AA267DDB8DB4
    53  uid           [ultimate] Aleksa Sarai <asarai@suse.com>
    54  uid           [ultimate] Aleksa Sarai <asarai@suse.de>
    55  sub   rsa4096 2016-06-21 [E] [expires: 2031-06-18]
    56  ```
    57  
    58  umoci is also available from several distribution's repositories:
    59  
    60  * [openSUSE](https://software.opensuse.org/package/umoci)
    61  * [Gentoo](https://packages.gentoo.org/packages/app-emulation/umoci)
    62  * [Arch Linux (AUR)](https://aur.archlinux.org/packages/umoci/)
    63  
    64  To build umoci from the [source code][source], a simple `make && make install`
    65  should work on most machines. The [changelog][changelog] is also available.
    66  
    67  [releases]: https://github.com/openSUSE/umoci/releases
    68  [umoci-keyring]: /umoci.keyring
    69  [source]: https://github.com/openSUSE/umoci
    70  [changelog]: /changelog
    71  
    72  ### License ###
    73  
    74  umoci is licensed under the terms of the Apache 2.0 license.
    75  
    76  ```text
    77  umoci: Umoci Modifies Open Containers' Images
    78  Copyright (C) 2016, 2017, 2018 SUSE LLC.
    79  
    80  Licensed under the Apache License, Version 2.0 (the "License");
    81  you may not use this file except in compliance with the License.
    82  You may obtain a copy of the License at
    83  
    84     http://www.apache.org/licenses/LICENSE-2.0
    85  
    86  Unless required by applicable law or agreed to in writing, software
    87  distributed under the License is distributed on an "AS IS" BASIS,
    88  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    89  See the License for the specific language governing permissions and
    90  limitations under the License.
    91  ```