Run Kinto¶
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.
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
It is possible to specify every Kinto setting through environment variables. For example, using an environment file:
# kinto.env
KINTO_USERID_HMAC_SECRET = tr0ub4d@ur
KINTO_BATCH_MAX_REQUESTS = 200
And running the container with docker run --env-file ./kinto.env ...
Using Python package¶
Python tooling¶
The following tools are necessary to initiate the local installation and use our helpers:
On Ubuntu/Debian, sudo apt-get install python-virtualenv
is enough.
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 loose 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
wget https://raw.githubusercontent.com/Kinto/kinto/master/config/kinto.ini
pserve kinto.ini
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.
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 add some custom settings, copy the provided file:
cp config/kinto.ini config/dev.ini
And specify the path when running:
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
Go further¶
Some suggestions for the next steps: