[](https://app.wercker.com/project/bykey/e9cbc4497ee946083aa19fbd3f756c91)
-[](https://openshift.redhat.com/app/console/application_type/custom?cartridges%5B%5D=python-2.7&cartridges%5B%5D=mongodb-2.4&initial_git_url=https://github.com/quokkaproject/quokka.git&name=quokka&initial_git_branch=master)
+[](https://openshift.redhat.com/app/console/application_type/custom?cartridges%5B%5D=python-2.7&cartridges%5B%5D=mongodb-2.4&initial_git_url=https://github.com/rochacbruno/quokka.git&name=quokka&initial_git_branch=master)
Quokka project
===============================================
@@ -49,20 +49,22 @@ User 'admin@example.com' and passwd 'admin' to login in to /admin
# Get Quokka
-## Get Quokka Master and enter in to its root directory
+
+# Using Docker
+
+The easiest way to run Quokka for development or production is using quokkaCMS + Gunicorn + Supervisor under a Docker Container. You can see the instructions in the following repository: https://github.com/quokkaproject/docker-gunicorn-supervisor
+
+
+## Get Quokka to run locally for development or deployment
```bash
-git clone https://github.com/quokkaproject/quokka --branch master --single-branch
+git clone https://github.com/rochacbruno/quokka --branch master --single-branch
cd quokka
```
> if you are cloning to contribute to the project just clone it without the "--branch=master --single-branch" part
-## Run Quokka
-
-You have 2 options **RUN LOCAL** or **RUN IN DOCKER**
-
-### RUN LOCAL
+### Run Quokka
Install needed packages in your local computer
@@ -94,6 +96,8 @@ You can install everything you need in your local computer or if preferred use a
MONGODB_USERNAME = None
MONGODB_PASSWORD = None
=============================================================
+
+ # You can also use envvars `export QUOKKA_MONGO_DB="yourdbname"`
```
3. If you have Docker installed you can simply run the official Mongo image
@@ -117,7 +121,8 @@ You can install everything you need in your local computer or if preferred use a
#### Python requirements
Install all needed python packages
-> activate your virtualenv if you want
+
+> If you have a virtualenv, activate it! `source env/bin/activate` or `workon env`
```bash
pip install -r requirements/requirements.txt
@@ -135,7 +140,7 @@ pip install -r requirements/requirements.txt
P4$$W0Rd
```
- 4. Populate with sample data (optional if you want sample data)
+ 4. Populate with sample data (optional if you want sample data for testing)
```bash
$ python manage.py populate
@@ -148,68 +153,7 @@ pip install -r requirements/requirements.txt
```
- Site on [http://localhost:5000](http://localhost:5000)
- Admin on [http://localhost:5000/admin](http://localhost:5000/admin)
-
-
-### RUN IN DOCKER
-
-- Run pre built docker images with everything pre-installed
-- You will need docker and docker compose installed in your machine
-- Once in Docker all data is stored behind quokka/etc folder
-
-
-#### Install Docker and docker-compose
-
-- **Docker** - https://docs.docker.com/installation/
-- **Docker-Compose** - https://docs.docker.com/compose/install/
-
-
-> Ensure that local port 27017(mongo) is not being used on your computer
-
-* ### Run with docker-compose
-
- 1. Easiest way is just running the following command in quokka root folder
- ```bash
- docker-compose up
- ```
-
- > use -d on above to leave it as a daemon
-
- 2. You can create a new admin user to login and start posting
- ```bash
- docker-compose run web python manage.py accounts_createsuperuser
- ```
-
- 3. Or populate with sample data (optional)
- ```bash
- docker-compose run web python manage.py populate
- ```
- > credentials for /admin will be email: admin@example.com passwd: admin
-
- 4. You enter Quokka Shell (in a separate console) or run any other command in place of **shell*
- ```bash
- docker-compose run web python manage.py shell
- ```
-
-* ### Run standalone containers
-> (each in separate shells or use -d option)
-
- 1. run mongo container
- ```bash
- docker run -v $PWD/etc/mongodata:/data/db -p 27017:27017 --name mongo mongo
- ```
-
- 2. run quokka web app container
- ```bash
- docker run -e "QUOKKA_MONGODB_HOST=mongo" -p 5000:5000 --link mongo:mongo -v $PWD:/quokka --workdir /quokka -t -i quokka/quokkadev python manage.py runserver --host 0.0.0.0
-
- ```
-
- 3. run quokka shell if needed
- ```bash
- docker run -e "QUOKKA_MONGODB_HOST=mongo" -p 5000:5000 --link mongo:mongo -v $PWD:/quokka --workdir /quokka -t -i quokka/quokkadev python manage.py shell
-
- ```
-
+
## Deployment
@@ -223,18 +167,18 @@ http://quokkaproject.org/documentation
> If you want to help writing the docs please go to https://github.com/quokkaproject/quokkaproject.github.io
-Also there is a [Wiki](https://github.com/quokkaproject/quokka/wiki)
+Also there is a [Wiki](https://github.com/rochacbruno/quokka/wiki)
===============================================
> NOTE: the content from wiki will be moved to /documentation
-* [About & Features](https://github.com/quokkaproject/quokka/wiki/about)
-* [Installing and running](https://github.com/quokkaproject/quokka/wiki/installation)
-* [Requirements](https://github.com/quokkaproject/quokka/wiki/requirements)
-* [Extending & Installing modules](https://github.com/quokkaproject/quokka/wiki/plugins)
-* [Admin interface](https://github.com/quokkaproject/quokka/wiki/screencast)
-* [Project tree](https://github.com/quokkaproject/quokka/wiki/project-tree)
-* [Team & Committers](https://github.com/quokkaproject/quokka/graphs/contributors)
+* [About & Features](https://github.com/rochacbruno/quokka/wiki/about)
+* [Installing and running](https://github.com/rochacbruno/quokka/wiki/installation)
+* [Requirements](https://github.com/rochacbruno/quokka/wiki/requirements)
+* [Extending & Installing modules](https://github.com/rochacbruno/quokka/wiki/plugins)
+* [Admin interface](https://github.com/rochacbruno/quokka/wiki/screencast)
+* [Project tree](https://github.com/rochacbruno/quokka/wiki/project-tree)
+* [Team & Committers](https://github.com/rochacbruno/quokka/graphs/contributors)
Hosting
@@ -245,7 +189,7 @@ You can host a Quokka website in any VPS or cloud which supports Python and Flas
- PythonAnywhere can run Quokka with Mongo hosted at MongoLab
- DigitalOcean is a good option for a VPS
- Jelastic Cloud has the easiest Quokka deployment - http://docs.jelastic.com/ru/quokka-cms
-- OpenShift [one click deploy](https://openshift.redhat.com/app/console/application_type/custom?cartridges%5B%5D=python-2.7&cartridges%5B%5D=mongodb-2.4&initial_git_url=https://github.com/quokkaproject/quokka.git&name=quokka&initial_git_branch=master)
+- OpenShift [one click deploy](https://openshift.redhat.com/app/console/application_type/custom?cartridges%5B%5D=python-2.7&cartridges%5B%5D=mongodb-2.4&initial_git_url=https://github.com/rochacbruno/quokka.git&name=quokka&initial_git_branch=master)
diff --git a/docker-compose.yml b/docker-compose.yml
index 57d527996..0ed09d9ad 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -5,15 +5,6 @@ mongo:
volumes:
- ./etc/mongodata:/data/db
-# elastic:
-# image: catholabs/elastic-with-marvel
-# command: elasticsearch
-# volumes:
-# - etc/elasticdata:/usr/share/elasticsearch/data
-# ports:
-# - "9200:9200"
-# mem_limit: 1000000000
-
web:
restart: always
image: quokka/quokkadev
@@ -24,7 +15,6 @@ web:
- .:/quokka
links:
- mongo:mongo
- # - elastic:elastic
command: sh etc/docker_wait_to_start.sh
environment:
- QUOKKA_MONGODB_HOST=mongo
diff --git a/etc/fixtures/demo_data.json b/etc/fixtures/demo_data.json
index 26c0e7765..171fe253f 100644
--- a/etc/fixtures/demo_data.json
+++ b/etc/fixtures/demo_data.json
@@ -31,6 +31,38 @@
"order" : 0
}
]
+ },
+ {
+ "name" : "author",
+ "email" : "author@example.com",
+ "gravatar_email": "rochacbruno+quokka@gmail.com",
+ "password" : "author",
+ "roles" : [ "author" ],
+ "bio": "Quokka Example Author",
+ "tagline": "It is nice to write in Quokka CMS!",
+ "links": [
+ {
+ "title" : "facebook",
+ "link" : "http://facebook.com/quokkaproject",
+ "icon" : "facebook",
+ "css_class" : "facebook",
+ "order" : 0
+ },
+ {
+ "title" : "github",
+ "link" : "http://github.com/quokkaproject",
+ "icon" : "github",
+ "css_class" : "github",
+ "order" : 0
+ },
+ {
+ "title" : "twitter",
+ "link" : "http://twitter.com/quokkaproject",
+ "icon" : "twitter",
+ "css_class" : "twitter",
+ "order" : 0
+ }
+ ]
}
],
"configs": [
diff --git a/etc/fixtures/initial_data.json b/etc/fixtures/initial_data.json
index d8d178609..ca048991e 100644
--- a/etc/fixtures/initial_data.json
+++ b/etc/fixtures/initial_data.json
@@ -31,6 +31,38 @@
"order" : 0
}
]
+ },
+ {
+ "name" : "author",
+ "email" : "author@example.com",
+ "gravatar_email": "rochacbruno+quokka@gmail.com",
+ "password" : "author",
+ "roles" : [ "author" ],
+ "bio": "Quokka Example Author",
+ "tagline": "It is nice to write in Quokka CMS!",
+ "links": [
+ {
+ "title" : "facebook",
+ "link" : "http://facebook.com/quokkaproject",
+ "icon" : "facebook",
+ "css_class" : "facebook",
+ "order" : 0
+ },
+ {
+ "title" : "github",
+ "link" : "http://github.com/quokkaproject",
+ "icon" : "github",
+ "css_class" : "github",
+ "order" : 0
+ },
+ {
+ "title" : "twitter",
+ "link" : "http://twitter.com/quokkaproject",
+ "icon" : "twitter",
+ "css_class" : "twitter",
+ "order" : 0
+ }
+ ]
}
],
"configs": [
diff --git a/etc/openshift_clean.py b/etc/openshift_clean.py
index ecc031354..a05d4c5f5 100644
--- a/etc/openshift_clean.py
+++ b/etc/openshift_clean.py
@@ -5,7 +5,9 @@
OR AT YOUR OWN RISK!!!!
"""
from quokka import create_app
-from quokka.core.models import Content, Channel, Config
+from quokka.core.models.content import Content
+from quokka.core.models.config import Config
+from quokka.core.models.channel import Channel
from quokka.modules.accounts.models import User
app = create_app()
diff --git a/etc/openshift_settings.py b/etc/openshift_settings.py
index 030617eaf..809c396eb 100644
--- a/etc/openshift_settings.py
+++ b/etc/openshift_settings.py
@@ -24,6 +24,7 @@
LOGGER_FORMAT = '%(asctime)s %(name)-12s %(levelname)-8s %(message)s'
LOGGER_DATE_FORMAT = '%d.%m %H:%M:%S'
+DEBUG = False
if os.environ['OPENSHIFT_APP_NAME'] == 'quokkadevelopment':
DEBUG_TOOLBAR_ENABLED = True
DEBUG = True
@@ -33,7 +34,6 @@
MAP_STATIC_ROOT = (
'/robots.txt',
- '/sitemap.xml',
'/favicon.ico',
'/vaddy-c603c78bbeba8d9.html'
)
@@ -51,3 +51,11 @@
""
""
)
+
+OPBEAT = {
+ 'ORGANIZATION_ID': '87883697e9f64e85b1a8170ff664890a',
+ 'APP_ID': 'd924873719',
+ 'SECRET_TOKEN': 'a0fee12cdb9eca36320b42d2d50f57ceea260dc5',
+ 'INCLUDE_PATHS': ['quokka'],
+ 'DEBUG': DEBUG,
+}
diff --git a/manage.py b/manage.py
index c676b8055..28d66b8eb 100755
--- a/manage.py
+++ b/manage.py
@@ -72,6 +72,19 @@ def populate(filename, baseurl=None):
Populate(db, filepath=filename, baseurl=baseurl, app=app)()
+@core_cmd.command()
+@click.option(
+ '-f',
+ '--filename',
+ help='Fixtures JSON path',
+ default='./etc/fixtures/initial_data.json')
+@click.option('-b', '--baseurl', help='base url to use', default=None)
+def populate_reset(filename, baseurl=None):
+ """De-Populate the database with sample data"""
+ from quokka.utils.populate import Populate
+ Populate(db, filepath=filename, baseurl=baseurl, app=app).reset()
+
+
@core_cmd.command()
def showconfig():
"""Print all config variables"""
diff --git a/quokka/__init__.py b/quokka/__init__.py
index 84b836be4..8476003b0 100644
--- a/quokka/__init__.py
+++ b/quokka/__init__.py
@@ -1,23 +1,11 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
-VERSION = (0, 2, 0)
+from quokka.core.admin import create_admin
+from quokka.core.app import QuokkaApp
+from quokka.core.middleware import HTTPMethodOverrideMiddleware
+from quokka.ext import configure_extensions
-__version__ = ".".join(map(str, VERSION))
-__status__ = "Alpha"
-__description__ = "Flexible & modular CMS powered by Flask and MongoDB"
-__author__ = "Bruno Rocha  }})
{{current_user.display_name}}
+