Quokka CMS

##Running with supervisor and gunicorn in a docker container

Requirements

• git
• docker - https://docs.docker.com/installation/
• docker-Compose (1.7+ required) - https://docs.docker.com/compose/install/

NOTE: Follow the instructions above to install docker and docker-compose on your Operating System!

Prepare

git clone --recursive https://github.com/quokkaproject/docker-gunicorn-supervisor.git
cd docker-gunicorn-supervisor
docker-compose build

Run

NOTE: Only at the first run MongoDB will create its base files under data folder. It may take some minutes to start for the first time, so it is a good idea to warm it up once using the command docker-compose run mongo and wait until mongodb creates your structure for the first time, when you see the message waiting for connections on port 27017 MongoDB is ok! wait some seconds and press CTRL+C Mongo container will shutdown and you can continue to next step.

docker-compose up -d

Try it!

Access http://localhost:5000 or Configure nginx or another server to proxy that port.

Populating with sample data

You can populate with sample data, for testing the CMS

docker-compose exec quokka manage populate

Running management commands

You can run any command, the shell is very useful

docker-compose exec quokka manage < command-name >

Example to create a user:

$ docker-compose exec quokka manage accounts_createuser
Name: User
Email: [email protected]
Password: ****
Repeat for confirmation: ****
Role: admin
Bruno <[email protected]>

Available core commands:

  accounts_createrole       Create a role
  accounts_createsuperuser  Create a user with administrator permissions
  accounts_createuser       Create a user
  accounts_listroles        List all Roles and its members
  accounts_listusers        List all Users
  check                     Prints app status
  comments_listcomments     Prints a list of comments
  media_listmedias          Prints a list of medias
  populate                  Populate the database with sample data
  posts_listposts           Prints a list of posts
  runserver                 Run the Flask development server i.e.
  shell                     Runs a Python shell with Quokka context
  showconfig                Print all config variables

Commands may depend on the installed extra modules

Updating Quokka CMS core (optional)

Quokka is added as a git submodule, to update it use

git submodule update

Change configuration (optional)

It is with the default configurations for running, but you can change configs editing docker-compose.yml file.

Normally you will expose this service using a server like nginx, by default it runs using 5000 port, you change the port mapping in docker-compose.yml

    ports:
        # "HOST_PORT: CONTAINER_PORT"
        - "5000:5000"

Any quokka configurations can be replaced using environment

    environment:
        - QUOKKA_MONGODB_HOST=mongo
        - QUOKKA_MONGODB_DB=quokka_db
        - QUOKKA_DEFAULT_THEME=pure

Adding themes (optional)

Lets say you want to add a new theme, in example the material theme.

Add the theme submodule to themes folder

git submodule add https://github.com/quokkaproject/theme_material themes/material
git submodule init

Create the mapping adding "./themes/material:/quokka/quokka/themes/material" to volumes in docker-compose.yml

    volumes:
        ...
        - ./themes/material:/quokka/quokka/themes/material

Change the DEFAULT_THEME config using env vars

    environment:
        - QUOKKA_DEFAULT_THEME=material

optionally you can use local_settings.py file to rewrite config variables

Adding modules (optional)

The same process as adding a theme, lets say you want to add quokka-cart module.

Add the module submodule

git submodule add https://github.com/quokkaproject/quokka-cart modules/cart
git submodule init

Create the mapping

    volumes:
        ...
        - ./modules/cart:/quokka/quokka/modules/cart