# gramine

**Repository Path**: axellance/gramine

## Basic Information

- **Project Name**: gramine
- **Description**: gramine
- **Primary Language**: Unknown
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-04
- **Last Updated**: 2024-12-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

*****************************************
Gramine Library OS with Intel SGX Support
*****************************************

.. image:: https://readthedocs.org/projects/gramine/badge/?version=latest
   :target: http://gramine.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://www.bestpractices.dev/projects/8380/badge
   :target: https://www.bestpractices.dev/projects/8380
   :alt: OpenSSF Best Practices

*A Linux-compatible Library OS for Multi-Process Applications*


What is Gramine?
================

Gramine (formerly called *Graphene*) is a lightweight library OS, designed to
run a single application with minimal host requirements. Gramine can run
applications in an isolated environment with benefits comparable to running a
complete OS in a virtual machine -- including guest customization, ease of
porting to different OSes, and process migration.

Gramine supports native, unmodified Linux binaries on any platform. Currently,
Gramine runs on Linux and Intel SGX enclaves on Linux platforms.

In untrusted cloud and edge deployments, there is a strong desire to shield the
whole application from rest of the infrastructure. Gramine supports this “lift
and shift” paradigm for bringing unmodified applications into Confidential
Computing with Intel SGX. Gramine can protect applications from a malicious
system stack with minimal porting effort.

Gramine is a growing project and we have a growing contributor and maintainer
community. The code and overall direction of the project are determined by a
diverse group of contributors, from universities, small and large companies, as
well as individuals. Our goal is to continue this growth in both contributions
and community adoption.

Note that the Gramine project was formerly known as Graphene. However, the name
"Graphene" was deemed too common, could be impossible to trademark, and collided
with several other software projects. Thus, a new name "Gramine" was chosen.


Gramine documentation
=====================

The official Gramine documentation can be found at
https://gramine.readthedocs.io. Below are quick links to some of the most
important pages:

- `Gramine installation options
  <https://gramine.readthedocs.io/en/latest/installation.html>`__
- `Run a sample application
  <https://gramine.readthedocs.io/en/latest/run-sample-application.html>`__
- `Complete building instructions
  <https://gramine.readthedocs.io/en/latest/devel/building.html>`__
- `Gramine manifest file syntax
  <https://gramine.readthedocs.io/en/latest/manifest-syntax.html>`__
- `Performance tuning & analysis of SGX applications in Gramine
  <https://gramine.readthedocs.io/en/latest/performance.html>`__
- `Remote attestation in Gramine
  <https://gramine.readthedocs.io/en/latest/attestation.html>`__


Users of Gramine
================

We maintain `a list of companies
<https://gramine.readthedocs.io/en/latest/gramine-users.html>`__ experimenting
with Gramine for their confidential computing solutions.


Getting help
============

For any questions, please use `GitHub Discussions
<https://github.com/gramineproject/gramine/discussions>`__ or join us on our
`Gitter chat <https://gitter.im/gramineproject/community>`__.

For bug reports and feature requests, `post an issue on our GitHub repository
<https://github.com/gramineproject/gramine/issues>`__.

If you prefer emails, please send them to users@gramineproject.io
(`public archive <https://groups.google.com/g/gramine-users>`__).


Reporting security issues
=========================

Please report security issues to security@gramineproject.io. See also our
`security policy <SECURITY.md>`__.