Contributing a module
This page discusses how to create a Tarantool module and then get it published on Tarantool rocks page and included in official Tarantool images for Docker.
To learn how to create a simple module in Lua for local usage, check the corresponding how-to guide.
To help our contributors, we have created modulekit, a set of templates for creating Tarantool modules in Lua and C.
Note
As a prerequisite for using modulekit, install tarantool-dev package
first. For example, in Ubuntu say:
$ sudo apt-get install tarantool-dev
See README in “luakit” branch of tarantool/modulekit repository for detailed instructions and examples.
In some cases, you may want to create a Tarantool module in C rather than in Lua. For example, to work with specific hardware or low-level system interfaces.
See README in “ckit” branch of tarantool/modulekit repository for detailed instructions and examples.
Note
You can also create modules with C++, provided that the code does not throw exceptions.