Get started

Use the demo server or run your own Kinto, and follow our tutorials for the JavaScript client or the raw HTTP API!

Mozilla demo server

A Kinto instance is running at https://kinto.dev.mozaws.net/v1/

It should be enough to get started, but the records are flushed every day at 7:00 AM UTC.

Deploy an instance on Heroku

You want to get started with a working online Kinto server right now?

Deploy on Heroku

You have got a free plan for up to 10000 rows.

Deploy an instance on Scalingo

You want to get started with a working online Kinto server right now?

Deploy on Scalingo

You have got a free plan for a 512MB (512MB RAM, 512MB on disk) PostgreSQL database.

Using Docker

If you have Docker, Kinto can be started locally with a single command:

sudo docker run -p 8888:8888 kinto/kinto-server

The server should now be running on http://localhost:8888

Custom configuration

It is possible to specify every Kinto setting through environment variables. For example, using an environment file:

# kinto.env
KINTO_USERID_HMAC_SECRET = [email protected]
KINTO_BATCH_MAX_REQUESTS = 200
# KINTO_STORAGE_BACKEND = cliquet.storage.postgresql
# KINTO_STORAGE_URL = postgres://user:[email protected]/kintodb

And running the container with:

docker run --env-file ./kinto.env -p 8888:8888 kinto/kinto-server

The server should now be running on http://localhost:8888

Using Docker Compose

A sample configuration for Docker Compose is provided in the Kinto repository. It pulls the Kinto container and runs it with a PostgreSQL container.

wget https://raw.githubusercontent.com/Kinto/kinto/master/docker-compose.yml
sudo docker-compose up

Using the Python package

System requirements

Depending on the platform and chosen configuration, some libraries or extra services are required.

The following commands will install necessary tools for cryptography and Python packaging like Virtualenv.

Linux

On Debian / Ubuntu based systems:

apt-get install libffi-dev libssl-dev python-dev python-virtualenv

On RHEL-derivatives:

apt-get install libffi-devel openssl-devel python-devel python-virtualenv

OS X

Assuming brew is installed:

brew install libffi openssl pkg-config python

pip install virtualenv

Quick start

By default, for convenience, Kinto persists the records, permissions and internal cache in a volatile memory backend. On every restart, the server will lose its data, and multiple processes are not handled properly.

But it should be enough to get started!

Create a Python isolated environment (optional):

virtualenv env/
source env/bin/activate

Then install the package using the default configuration:

pip install kinto
kinto init
kinto migrate
kinto start

The server should now be running on http://localhost:8888

From sources

If you plan on contributing, this is the way to go!

This will install every necessary packages to run the tests, build the documentation etc.

Make sure you have the system requirements listed in the Python package section.

git clone https://github.com/Kinto/kinto.git
cd kinto/
make serve

The server should now be running with the default configuration on http://localhost:8888

In order to specify a particular settings file:

make serve SERVER_CONFIG=config/dev.ini

With make, it is also possible to specify arguments from environment variables:

export SERVER_CONFIG=config/dev.ini

make serve -e

See dedicated section about contributing!