This documentation aims to be a comprehensive guide to Xapiand. We'll cover topics such as getting your site up and running, indexing and searching documents, customizing data schemas, deploying to various environments, and give you some advice on participating in the future development of Xapiand itself.
So what is Xapiand, exactly?
Xapiand is A Modern Highly Available Distributed RESTful Search and Storage Engine built for the Cloud and with Data Locality in mind. It takes JSON (or MessagePack) documents and indexes them efficiently for later retrieval.
Helpful Hints
Throughout this guide there are a number of small-but-handy pieces of information that can make using {{ site.name }} easier, more interesting, and less hazardous. Here's what to look out for.
{: .note}
Tips help you get more from {{ site.name }}
These are tips and tricks that will help you be a {{ site.name }} wizard!
{: .note .info}
Notes are handy pieces of information
These are for the extra tidbits sometimes necessary to understand {{ site.name }}.
{: .note .warning}
Warnings help you not blow things up
Be aware of these messages if you wish to avoid certain death.
{: .note .unreleased}
You'll see this by a feature that hasn't been released
Some pieces are for future versions of {{ site.name }} that are not yet released.
API Snippets
Throughout this guide there are many examples of API calls that look something like this:
{% capture req %}
PUT /twitter/user/Kronuz
{
"name" : "German M. Bravo"
}
{% endcapture %} {% include curl.html req=req %}
For those, you can always copy the equivalent curl code for it by hovering the snippet and clicking on the copy to the clipboard button:
Donate to {{ site.name }}!
How will my donation be used?
Development of {{ site.name }} is done as an open-source project and maintaining it is hard and time consuming, if you like {{ site.name }}, please donate whatever you feel comfortable with via PayPal. The donations will be directly used to support {{ site.name }}'s developers.
How do I donate?
We accept donations via PayPal:
If you come across anything along the way that we haven't covered, or if you know of a tip you think others would find handy, please file an issue and we'll see about including it in this guide.