Platform for Mozilla Support
Перейти к файлу
Paul McLanahan 605ea772e9
Update db_strings.py from prod database
2018-11-08 13:19:02 -05:00
.circleci Use urlwait for circle tests 2018-10-22 12:11:38 -04:00
authority [Bug 1238055][Bug 1225606] Upgrade Django to 1.8. 2016-02-25 15:08:13 -08:00
bin Ignore slack errors during deployment (#3390) 2018-10-26 14:13:13 -05:00
configs Remove Vagrant. 2017-11-20 12:50:28 +02:00
docker Upgrade node version on dev image to match that on prod 2018-10-23 15:37:47 -04:00
docs Merge pull request #3297 from jpetto/fix-3045-remove-django-badger 2018-10-15 14:02:37 -05:00
jsi18n Collect jsi18n files via staticfiles to get hashed filenames. 2016-02-23 18:17:29 -08:00
k8s Block more bots (#3372) 2018-10-16 21:46:55 -05:00
kitsune Update db_strings.py from prod database 2018-11-08 13:19:02 -05:00
media Update base template code/styles based on new mockups for support.mozilla.org re-design. (#3243) 2018-09-18 16:35:34 -05:00
requirements Update test dependencies. 2018-11-06 12:36:32 -05:00
scripts rm -rf scripts/update 2018-09-28 12:49:30 -04:00
tests Move WebQA Jenkinsfile under tests dir. 2017-11-23 09:22:37 +02:00
wsgi Migrate from raven to sentry-sdk 2018-11-05 11:08:18 -05:00
.dockerignore Split dockerfiles. 2017-11-30 15:39:49 +02:00
.editorconfig [fix #3321] Improve support forum question UI. 2018-10-15 13:23:44 -04:00
.env-build Update env variables 2018-03-01 09:02:15 -06:00
.env-dist Preserved legacy trackEvent function, added analytics.js back to bundle 2018-03-21 10:24:40 +02:00
.env-test Persistent DB connection when testing. 2018-03-06 06:39:32 -06:00
.eslintrc Fix eslint problems. 2015-12-15 15:23:27 -08:00
.gitignore Upgrade node version on dev image to match that on prod 2018-10-23 15:37:47 -04:00
.pre-commit-config.yaml Upgrade to pip8 2017-11-20 12:50:09 +02:00
.travis.yml Switch docker repo to mozmeao/kitsune. 2017-11-23 09:58:28 +02:00
CONTRIBUTORS.rst Replace manually curated list of contributors with link to generated versions. 2015-05-21 14:07:01 -07:00
Jenkinsfile Add slack notifications to Jenkins build job 2018-07-27 14:34:17 -04:00
LICENSE Fix a thing Ricky found that I missed when I fixed the other issue 2013-04-05 16:06:06 -04:00
Procfile Add celery worker and cron commands. 2018-02-05 12:20:57 +02:00
README.md Upgrade node version on dev image to match that on prod 2018-10-23 15:37:47 -04:00
bower.json Fix issues associated with broken bower config 2018-10-23 14:43:13 -04:00
contribute.json Update and serve contribute.json (#2905) 2017-08-03 10:02:01 +03:00
docker-compose.yml Revert "Add max_allow_packet to mysql container." 2018-03-06 05:58:05 -06:00
gulpfile.js Fix a lot of lint errors. 2015-07-28 17:02:18 -07:00
jenkins.yml Switch docker repo to mozmeao/kitsune. 2017-11-23 09:58:28 +02:00
manage.py Update docker. 2017-11-20 12:54:12 +02:00
newrelic.ini Add newrelic configuration file. (#3051) 2018-02-08 05:58:24 -06:00
package.json update bower to latest version for fixing bug 1500894 2018-10-23 14:42:23 -04:00
setup.cfg Run tests on travis. 2017-11-20 13:07:07 +02:00
tox.ini Add Jenkinsfile pipeline 2016-11-15 10:51:50 +00:00
yarn.lock Upgrade node version on dev image to match that on prod 2018-10-23 15:37:47 -04:00

README.md

Kitsune

Kitsune is the platform that powers SuMo (support.mozilla.org)

It is a Django application. There is documentation online.

You can access the staging site at https://support.allizom.org/

See what's deployed

Development

To setup a local Kitsune development environment:

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

  2. Download base Kitsune docker images:

    docker pull mozmeao/kitsune:base-latest
    docker pull mozmeao/kitsune:base-dev-latest
    
  3. Build Kitsune docker images. (Only needed on initial build or when packages change)

    docker-compose -f docker-compose.yml -f docker/composefiles/build.yml build base
    docker-compose -f docker-compose.yml -f docker/composefiles/build.yml build dev
    
  4. Copy .env-dist to .env

    cp .env-dist .env
    
  5. Create your database

    docker-compose -f docker-compose.yml -f docker/composefiles/dev.yml run web ./manage.py migrate
    
  6. Install node and bower packages

    docker-compose -f docker-compose.yml -f docker/composefiles/dev.yml run web yarn
    docker-compose -f docker-compose.yml -f docker/composefiles/dev.yml run web ./node_modules/.bin/bower install --allow-root
    
  7. (Optional) Enable the admin control panel

    echo "ENABLE_ADMIN=True" >> .env
    
  8. Run Kitsune

    docker-compose -f docker-compose.yml -f docker/composefiles/dev.yml up web
    

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

  9. (Optional) Create a superuser

    docker-compose -f docker-compose.yml -f docker/composefiles/dev.yml exec web ./manage.py createsuperuser
    
  10. (Optional) Create some data

    docker-compose -f docker-compose.yml -f docker/composefiles/dev.yml exec web ./manage.py generatedata
    
  11. (Optional) Update product details

    docker-compose -f docker-compose.yml -f docker/composefiles/dev.yml exec web ./manage.py update_product_details
    
  12. (Optional) Get search working

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

    1. Enter the web container: docker exec -it kitsune_web_1 /bin/bash
    2. Build the indicies: ./manage.py esreindex (You may need to pass the --delete flag)
    3. Precompile the nunjucks templates: ./manage.py nunjucks_precompile