summaryrefslogtreecommitdiffstats
path: root/storage/maria/libmarias3/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'storage/maria/libmarias3/README.rst')
-rw-r--r--storage/maria/libmarias3/README.rst68
1 files changed, 68 insertions, 0 deletions
diff --git a/storage/maria/libmarias3/README.rst b/storage/maria/libmarias3/README.rst
new file mode 100644
index 00000000..2d9a7f49
--- /dev/null
+++ b/storage/maria/libmarias3/README.rst
@@ -0,0 +1,68 @@
+libMariaS3
+==========
+
+.. image:: https://readthedocs.org/projects/libmarias3/badge/?version=latest
+ :target: https://libmarias3.readthedocs.io/en/latest/?badge=latest
+ :alt: Documentation Status
+
+This is a lightweight C library to read/write to AWS S3 buckets using objects in memory.
+
+You will need an access key which for AWS can be created at `the AWS security crenditials page <https://console.aws.amazon.com/iam/home?#/security_credentials>`_.
+
+Compiling
+---------
+
+.. code-block:: bash
+
+ autoreconf -fi
+ ./configure
+ make
+
+Testing
+-------
+
+libMariaS3 comes with a basic test suite which we recommend executing, especially if you are building for a new platform.
+
+You will need the following OS environment variables set to run the tests:
+
++------------+----------------------------------------------------------+
+| Variable | Desription |
++============+==========================================================+
+| S3KEY | Your AWS access key |
++------------+----------------------------------------------------------+
+| S3SECRET | Your AWS secret key |
++------------+----------------------------------------------------------+
+| S3REGION | The AWS region (for example us-east-1) |
++------------+----------------------------------------------------------+
+| S3BUCKET | The S3 bucket name |
++------------+----------------------------------------------------------+
+| S3HOST | OPTIONAL hostname for non-AWS S3 service |
++------------+----------------------------------------------------------+
+| S3PORT | OPTIONAL port for non-AWS S3 service |
++------------+----------------------------------------------------------+
+| S3USEHTTP | Set to ``1`` if the host uses http instead of https |
++------------+----------------------------------------------------------+
+| S3NOVERIFY | Set to ``1`` if the host should not use SSL verification |
++------------+----------------------------------------------------------+
+
+The test suite is automatically built along with the library and can be executed with ``make check`` or ``make distcheck``.
+
+Before pushing, please ALWAYS ensure that ``make check`` and ``make distcheck`` works!
+
+
+Credits
+-------
+
+The libMariaS3 authors are:
+
+* `Andrew (LinuxJedi) Hutchings <mailto:andrew@linuxjedi.co.uk>`_
+ - Starting with this commit, all my contributions are under the 3-clause BSD license.
+* `Sergei Golubchik <mailto:sergei@mariadb.com>`_
+* `Markus Mäkelä <markus.makela@mariadb.com>`_
+
+libMariaS3 uses the following Open Source projects:
+
+* `libcurl <https://curl.haxx.se/>`_
+* `xml.c <https://github.com/ooxi/xml.c/>`_
+* `DDM4 <https://github.com/TangentOrg/ddm4>`_
+* `Jouni Malinen's SHA256 hash code <j@w1.fi>`_