quokka 0.3.2

Install quokka

pip install quokka

NOTE: QuokkaCMS runs only in Python 3.6+

Start a project

quokka init mywebsite
Generating new quokka project in ./mywebsite folder

The above command will generate your project in myproject folder as:

.
├── databases        # TinyDB database files (gitignored)
├── static_build     # output static site
├── themes           # Pelican Themes
├── uploads          # Media uploaded via admin
├── .gitignore       # gitignore to exclude sensitive files
├── manage.yml       # Controls the `quokka` cli commands and shell
├── .secrets.yml     # To store keys, tokens and passwords (gitignored)
├── settings.yml     # CMS settings
└── wsgi.py          # To deploy `gunicorn wsgi:app`

You can optionally pass arguments:

Choose existing theme (the default is Flex)

quokka init mywebsite --theme http://github.com/user/theme

Install modules

quokka init mywebsite --theme http://github.com/user/theme --modules="commerce,foo"

the above looks for ``quokka_commerce`` and ``quokka_foo`` in PyPI
and installs it

Set important configurations

quokka init mywebsite --theme http://github.com/user/theme --config="auth_enabled=false"

That is optional, you have to edit ``settings.yml`` to tune your
settings.

Run your website

quokka runserver --port 5000

Access admin interface

http://localhost:5000/admin

Access your site

http://localhost:5000

You can generate a static HTML website to host anywhere

Once you have your website running locally you can easily generate a static HTML website from it.

$ quokka publish --static [--output path]
Generating static HTML website on ./static_build folder

Once you have a ./static_build folder populated with static website you can deploy it using SCP, FTP or git, it is a full static website.

Deploying to github pages from command line

NOTE: You need either ssh key access to github or it will ask login/password

quokka publish --static --git=rochacbruno/mysite --branch=gh_pages

The above is also available in admin under 'publish' menu.

Deploying via SCP

quokka publish --static --scp --dest='me@hostname:/var/www/mysite' [--sshkey ~/.ssh/key] [--password xyz]
password : ...

Deploying to Heroku

This requires heroku client installed, if Procfile is not found it will be generated

quokka publish --static --heroku --options

Deploying via FTP

quokka publish --static --ftp --host='ftp://server.com' --dest='/var/www/mysite'

Load database from remote deployment (only for TinyDB)

When you publish a static website along with the static files the database also goes to the server under the databases/ folder only as a backup and snapshot.

You can load that remote database locally e.g: to add new posts and then re-publish

quokka restoredb --remote --git=rochacbruno/mysite
Creating a backup of local database...
Downloading remote database
Restoring database..
Done...

Now you can run quokka runserver open your localhost:5000/admin write new content and then Publish website again using command line or admin interface.

NOTE: If you want to restore a local database use --local and --path path/to/db