Skip to content
Branch: master
Go to file

Latest commit


Failed to load latest commit information.
Latest commit message
Commit time
Nov 20, 2017
Jan 10, 2019


Kitsune is the platform that powers SuMo (

It is a Django application. There is documentation online.

You can access the staging site at

See what's deployed

Code of Conduct

By participating in this project, you're agreeing to uphold the Mozilla Community Participation Guidelines. If you need to report a problem, please see our guide.


To get Kitsune running locally all you really need is to have Docker and Docker Compose installed, and follow the following steps.

  1. Fork this repository & clone it to your local machine.

    git clone
  2. Pull base Kitsune Docker images, run collectstatic, create your database, and install node packages.

    make init
    make build
  3. Run Kitsune.

    make run

    This will produce a lot of output (mostly warnings at present). When you see the following the server will be ready:

    web_1              | Starting development server at
    web_1              | Quit the server with CONTROL-C.

The running instance will be located at http://localhost:8000/ unless you specified otherwise, and the administrative control panel will be at http://localhost:8000/admin/.

Another way you might choose to run the app (step 3 above) is by getting a shell in the container and then manually running the Django dev server from there. This should make frequent restarts of the server a lot faster and easier if you need to do that:

make runshell

The end result of this method should be the same as using make run, but will potentially aid in debugging and act much more like developing without Docker as you may be used to. You should use make runshell here instead of make shell as the latter does not bind port 8000 which you need to be able to load the site.

Run make help to see other helpful commands.

Finally you can run the development server with instance reloading through browser-sync.

npm start

The running instance in this case will be located at http://localhost:3000/.

The Admin

After the above you can do some optional steps if you want to use the admin:

  • Enable the admin control panel

    echo "ENABLE_ADMIN=True" >> .env
  • Create a superuser

    docker-compose exec web ./ createsuperuser
  • Create some data

    docker-compose exec web ./ generatedata
  • Update product details

    docker-compose exec web ./ update_product_details

Get Search Working

First, make sure you have run the "Create some data" step above.

  1. Enter the web container: docker-compose exec web bash
  2. Build the indicies: ./ esreindex (You may need to pass the --delete flag)
  3. Precompile the nunjucks templates: ./ nunjucks_precompile
You can’t perform that action at this time.