README.rst
1libMariaS3
2==========
3
4.. image:: https://readthedocs.org/projects/libmarias3/badge/?version=latest
5 :target: https://libmarias3.readthedocs.io/en/latest/?badge=latest
6 :alt: Documentation Status
7
8This is a lightweight C library to read/write to AWS S3 buckets using objects in memory.
9
10You 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>`_.
11
12Compiling
13---------
14
15.. code-block:: bash
16
17 autoreconf -fi
18 ./configure
19 make
20
21Testing
22-------
23
24libMariaS3 comes with a basic test suite which we recommend executing, especially if you are building for a new platform.
25
26You will need the following OS environment variables set to run the tests:
27
28+------------+----------------------------------------------------------+
29| Variable | Desription |
30+============+==========================================================+
31| S3KEY | Your AWS access key |
32+------------+----------------------------------------------------------+
33| S3SECRET | Your AWS secret key |
34+------------+----------------------------------------------------------+
35| S3REGION | The AWS region (for example us-east-1) |
36+------------+----------------------------------------------------------+
37| S3BUCKET | The S3 bucket name |
38+------------+----------------------------------------------------------+
39| S3HOST | OPTIONAL hostname for non-AWS S3 service |
40+------------+----------------------------------------------------------+
41| S3PORT | OPTIONAL port for non-AWS S3 service |
42+------------+----------------------------------------------------------+
43| S3USEHTTP | Set to ``1`` if the host uses http instead of https |
44+------------+----------------------------------------------------------+
45| S3NOVERIFY | Set to ``1`` if the host should not use SSL verification |
46+------------+----------------------------------------------------------+
47
48The test suite is automatically built along with the library and can be executed with ``make check`` or ``make distcheck``.
49
50Before pushing, please ALWAYS ensure that ``make check`` and ``make distcheck`` works!
51
52
53Credits
54-------
55
56The libMariaS3 authors are:
57
58* `Andrew (LinuxJedi) Hutchings <mailto:andrew@linuxjedi.co.uk>`_
59 - Starting with this commit, all my contributions are under the 3-clause BSD license.
60* `Sergei Golubchik <mailto:sergei@mariadb.com>`_
61* `Markus Mäkelä <markus.makela@mariadb.com>`_
62
63libMariaS3 uses the following Open Source projects:
64
65* `libcurl <https://curl.haxx.se/>`_
66* `xml.c <https://github.com/ooxi/xml.c/>`_
67* `DDM4 <https://github.com/TangentOrg/ddm4>`_
68* `Jouni Malinen's SHA256 hash code <j@w1.fi>`_
69