├── VERSION ├── contrib ├── postgres │ ├── docker-entrypoint-initdb.d │ │ ├── .gitattributes │ │ ├── 30_setup_test_databases.sh │ │ ├── 10_create_ckandb.sh │ │ └── 20_create_datstore.sh │ ├── Dockerfile │ └── add-databases.sh ├── ckan-datapusher │ ├── setup │ │ └── requirements.txt │ ├── Makefile │ └── Dockerfile ├── solr │ └── Dockerfile └── ckan │ └── docker-entrypoint.d │ └── openafrica_ckan.sh ├── .bumpversion.cfg ├── .github ├── ISSUE_TEMPLATE │ ├── blank-template.md │ ├── feature_request.md │ ├── general-issue-template.md │ └── bug_report.md ├── ISSUE_TEMPLATE.md └── PULL_REQUEST_TEMPLATE.md ├── Procfile ├── requirements.txt ├── Makefile ├── docker-compose.yml ├── .env.tmpl ├── .gitignore ├── Dockerfile ├── CONTRIBUTING.md ├── CODE_OF_CONDUCT.md ├── README.md └── LICENSE /VERSION: -------------------------------------------------------------------------------- 1 | 0.1.2 2 | -------------------------------------------------------------------------------- /contrib/postgres/docker-entrypoint-initdb.d/.gitattributes: -------------------------------------------------------------------------------- 1 | *.sh text eol=lf -------------------------------------------------------------------------------- /.bumpversion.cfg: -------------------------------------------------------------------------------- 1 | [bumpversion] 2 | current_version = 0.1.2 3 | commit = True 4 | tag = True 5 | 6 | [bumpversion:file:VERSION] 7 | 8 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/blank-template.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Blank Template 3 | about: Use sparingly but gives you the creative freedom. 4 | 5 | --- 6 | 7 | 8 | -------------------------------------------------------------------------------- /contrib/postgres/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM postgres:12-alpine 2 | 3 | # Include extra setup scripts (eg datastore) 4 | COPY --chown=postgres:postgres docker-entrypoint-initdb.d /docker-entrypoint-initdb.d 5 | -------------------------------------------------------------------------------- /contrib/ckan-datapusher/setup/requirements.txt: -------------------------------------------------------------------------------- 1 | argparse 2 | Flask<2.4 3 | ckanserviceprovider==1.1.0 4 | html5lib==1.0.1 5 | messytables==0.15.2 6 | certifi 7 | requests[security]==2.27.1 8 | Werkzeug~=2.0.2 9 | -------------------------------------------------------------------------------- /Procfile: -------------------------------------------------------------------------------- 1 | web: gunicorn --workers 5 --worker-class gevent --ckan ckan.ini -t 10800 2 | 3 | ckan_gather_consumer: ckan --config=ckan.ini --plugin=ckanext-harvest harvester gather_consumer 4 | 5 | ckan_fetch_consumer: ckan --config=ckan.ini --plugin=ckanext-harvest harvester fetch_consumer 6 | -------------------------------------------------------------------------------- /contrib/postgres/docker-entrypoint-initdb.d/30_setup_test_databases.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | 4 | psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL 5 | CREATE DATABASE ckan_test OWNER "$CKAN_DB_USER" ENCODING 'utf-8'; 6 | CREATE DATABASE datastore_test OWNER "$CKAN_DB_USER" ENCODING 'utf-8'; 7 | EOSQL 8 | -------------------------------------------------------------------------------- /contrib/postgres/docker-entrypoint-initdb.d/10_create_ckandb.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | 4 | psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL 5 | CREATE ROLE "$CKAN_DB_USER" NOSUPERUSER CREATEDB CREATEROLE LOGIN PASSWORD '$CKAN_DB_PASSWORD'; 6 | CREATE DATABASE "$CKAN_DB" OWNER "$CKAN_DB_USER" ENCODING 'utf-8'; 7 | EOSQL 8 | -------------------------------------------------------------------------------- /contrib/postgres/docker-entrypoint-initdb.d/20_create_datstore.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | 4 | psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL 5 | CREATE ROLE "$DATASTORE_READONLY_USER" NOSUPERUSER NOCREATEDB NOCREATEROLE LOGIN PASSWORD '$DATASTORE_READONLY_PASSWORD'; 6 | CREATE DATABASE "$DATASTORE_DB" OWNER "$CKAN_DB_USER" ENCODING 'utf-8'; 7 | EOSQL 8 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Description 2 | A clear and concise description of what the issue is about. 3 | 4 | ## Screenshots 5 | 6 | 7 | ## Files 8 | A list of relevant files for this issue. This will help people navigate the project and offer some clues of where to start. 9 | 10 | ## To Reproduce 11 | If this issue is describing a bug, include some steps to reproduce the behavior. 12 | 13 | ## Tasks 14 | Include specific tasks in the order they need to be done in. Include links to specific lines of code where the task should happen at. 15 | - [ ] Task 1 16 | - [ ] Task 2 17 | - [ ] Task 3 18 | 19 | -------------------------------------------------------------------------------- /contrib/ckan-datapusher/Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: all help build build-all push 2 | SHELL := /bin/bash 3 | DATAPUSHER_VERSION=0.0.20 4 | TAG_NAME="ckan/ckan-base-datapusher:$(DATAPUSHER_VERSION)" 5 | 6 | all: help 7 | help: 8 | @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' 9 | 10 | build: ## Build a DataPusher image 11 | echo "Building DataPusher image for version $(DATAPUSHER_VERSION)" 12 | docker build -t $(TAG_NAME) --build-arg DATAPUSHER_VERSION=$(DATAPUSHER_VERSION) . 13 | 14 | push: ## Push a DataPusher image to the Docker Hub registry 15 | docker push $(TAG_NAME) 16 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | 5 | --- 6 | 7 | **Is your feature request related to a problem? Please describe.** 8 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 9 | 10 | **Describe the solution you'd like** 11 | A clear and concise description of what you want to happen. 12 | 13 | **Describe alternatives you've considered** 14 | A clear and concise description of any alternative solutions or features you've considered. 15 | 16 | **Additional context** 17 | Add any other context or screenshots about the feature request here. 18 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/general-issue-template.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: General Issue Template 3 | about: A general issue template. 4 | 5 | --- 6 | 7 | ## Description 8 | A clear and concise description of what the issue is about. 9 | 10 | ## Screenshots 11 | 12 | 13 | ## Files 14 | A list of relevant files for this issue. This will help people navigate the project and offer some clues of where to start. 15 | 16 | ## To Reproduce 17 | If this issue is describing a bug, include some steps to reproduce the behavior. 18 | 19 | ## Tasks 20 | Include specific tasks in the order they need to be done in. Include links to specific lines of code where the task should happen at. 21 | - [ ] Task 1 22 | - [ ] Task 2 23 | - [ ] Task 3 24 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | ## Description 2 | 3 | Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. 4 | 5 | Fixes # (issue) 6 | 7 | ## Type of change 8 | 9 | Please delete options that are not relevant. 10 | 11 | - [ ] Bug fix (non-breaking change which fixes an issue) 12 | - [ ] New feature (non-breaking change which adds functionality) 13 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) 14 | - [ ] This change requires a documentation update 15 | 16 | 17 | ## Screenshots 18 | 19 | 20 | ## Checklist: 21 | 22 | - [ ] My code follows the style guidelines of this project 23 | - [ ] I have performed a self-review of my own code 24 | - [ ] I have commented my code, particularly in hard-to-understand areas 25 | - [ ] I have made corresponding changes to the documentation 26 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | 5 | --- 6 | 7 | **Describe the bug** 8 | A clear and concise description of what the bug is. 9 | 10 | **To Reproduce** 11 | Steps to reproduce the behavior: 12 | 1. Go to '...' 13 | 2. Click on '....' 14 | 3. Scroll down to '....' 15 | 4. See error 16 | 17 | **Expected behavior** 18 | A clear and concise description of what you expected to happen. 19 | 20 | **Screenshots** 21 | If applicable, add screenshots to help explain your problem. 22 | 23 | **Desktop (please complete the following information):** 24 | - OS: [e.g. iOS] 25 | - Browser [e.g. chrome, safari] 26 | - Version [e.g. 22] 27 | 28 | **Smartphone (please complete the following information):** 29 | - Device: [e.g. iPhone6] 30 | - OS: [e.g. iOS8.1] 31 | - Browser [e.g. stock browser, safari] 32 | - Version [e.g. 22] 33 | 34 | **Additional context** 35 | Add any other context about the problem here. 36 | -------------------------------------------------------------------------------- /contrib/postgres/add-databases.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | set -e 4 | set -u 5 | 6 | function create_user_and_database() { 7 | local database=$(echo $1 | tr ':' ' ' | awk '{print $1}') 8 | local owner=$(echo $1 | tr ':' ' ' | awk '{print $2}') 9 | echo " Creating user and database '$database'" 10 | psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" <<-EOSQL 11 | DO 12 | \$do\$ 13 | BEGIN 14 | IF NOT EXISTS ( 15 | SELECT -- SELECT list can stay empty for this 16 | FROM pg_catalog.pg_roles 17 | WHERE rolname = '$owner') THEN 18 | 19 | CREATE ROLE $owner LOGIN PASSWORD '$POSTGRES_PASSWORD'; 20 | END IF; 21 | END 22 | \$do\$; 23 | CREATE DATABASE $database; 24 | GRANT ALL PRIVILEGES ON DATABASE $database TO $owner; 25 | GRANT ALL PRIVILEGES ON DATABASE $database TO $POSTGRES_USER; 26 | EOSQL 27 | } 28 | 29 | if [ -n "$POSTGRES_ADD_DATABASES" ]; then 30 | echo "Multiple database creation requested: $POSTGRES_ADD_DATABASES" 31 | for db in $(echo $POSTGRES_ADD_DATABASES | tr ',' ' '); do 32 | create_user_and_database $db 33 | done 34 | echo "Multiple databases created" 35 | fi 36 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | gunicorn==19.7.0 2 | gevent==20.9.0 3 | cryptography 4 | pyOpenSSL 5 | 6 | 7 | # CKAN Extensions 8 | 9 | -e git+https://github.com/CodeForAfrica/ckanext-openafrica.git@ft/ui-changes#egg=ckanext-openafrica 10 | # -e git+https://github.com/CodeForAfrica/ckanext-openafrica.git#egg=ckanext-openafrica 11 | 12 | # -e git+https://github.com/CodeForAfrica/ckanext-openafrica.git#egg=ckanext-openafrica 13 | 14 | -e git+https://github.com/okfn/ckanext-envvars.git@0.0.1#egg=ckanext-envvars 15 | -e git+https://github.com/okfn/ckanext-s3filestore.git@v0.1.1#egg=ckanext-s3filestore 16 | 17 | -e git+https://github.com/ckan/ckanext-showcase.git@v1.1.0#egg=ckanext-showcase 18 | -e git+https://github.com/conwetlab/ckanext-datarequests.git@v1.1.0#egg=ckanext-datarequests 19 | 20 | -e git+https://github.com/ckan/ckanext-issues.git#egg=ckanext-issues 21 | 22 | -e git+https://github.com/ckan/ckanext-harvest.git@v1.2.1#egg=ckanext-harvest 23 | -e git+https://github.com/ckan/ckanext-dcat.git@v1.1.3#egg=ckanext-dcat 24 | 25 | -e git+https://github.com/ckan/ckanext-pdfview.git@0.0.5#egg=ckanext-pdfview 26 | 27 | -e git+https://github.com/OpenUpSA/ckanext-gdoc.git#egg=ckanext-gdoc 28 | -e git+https://github.com/jqnatividad/ckanext-officedocs.git#egg=ckanext-officedocs 29 | 30 | -e git+https://github.com/okfn/ckanext-sentry.git@d3b1d1cf1f975b3672891012e6c75e176497db8f#egg=ckanext-sentry 31 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | include $(PWD)/.env 2 | 3 | build: 4 | docker compose build 5 | 6 | up: 7 | docker compose up 8 | 9 | build-web: 10 | docker compose build web 11 | 12 | web: 13 | docker compose up web 14 | 15 | bash: 16 | docker compose exec web bash 17 | 18 | db-init: 19 | docker compose exec web ckan -c ckan.ini db init 20 | 21 | db-upgrade: 22 | docker compose exec web ckan -c ckan.ini db upgrade 23 | 24 | rebuild-index: 25 | docker compose exec web ckan -c ckan.ini search-index rebuild 26 | 27 | issues-init: 28 | docker compose exec web ckan -c ckan.ini issues init_db 29 | 30 | ckan: 31 | docker buildx build --platform linux/amd64 --no-cache --build-arg CKAN_VERSION=$(CKAN_VERSION) --tag codeforafrica/ckan:latest --tag codeforafrica/ckan:$(CKAN_VERSION) . 32 | 33 | ckan-publish: 34 | docker push codeforafrica/ckan:latest 35 | docker push codeforafrica/ckan:$(CKAN_VERSION) 36 | 37 | solr: 38 | docker buildx build --platform linux/amd64 --no-cache --build-arg CKAN_VERSION=$(CKAN_VERSION) --tag codeforafrica/ckan-solr:latest --tag codeforafrica/ckan-solr:$(CKAN_SOLR_VERSION) contrib/solr 39 | 40 | solr-publish: 41 | docker push codeforafrica/ckan-solr:latest 42 | docker push codeforafrica/ckan-solr:$(CKAN_SOLR_VERSION) 43 | 44 | datapusher: 45 | docker buildx build --platform linux/amd64 --tag codeforafrica/ckan-datapusher:latest --tag codeforafrica/ckan-datapusher:$(DATAPUSHER_VERSION) contrib/ckan-datapusher 46 | 47 | datapusher-publish: 48 | docker push codeforafrica/ckan-datapusher:latest 49 | docker push codeforafrica/ckan-datapusher:$(DATAPUSHER_VERSION) 50 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | # docker-compose build && docker-compose up 4 | services: 5 | db: 6 | container_name: ${POSTGRESQL_CONTAINER_NAME} 7 | build: 8 | context: contrib/postgres 9 | dockerfile: Dockerfile 10 | environment: 11 | - POSTGRES_USER=${POSTGRES_USER} 12 | - POSTGRES_PASSWORD=${POSTGRES_PASSWORD} 13 | - POSTGRES_DB=${POSTGRES_DB} 14 | - CKAN_DB_USER=${CKAN_DB_USER} 15 | - CKAN_DB_PASSWORD=${CKAN_DB_PASSWORD} 16 | - CKAN_DB=${CKAN_DB} 17 | - DATASTORE_READONLY_USER=${DATASTORE_READONLY_USER} 18 | - DATASTORE_READONLY_PASSWORD=${DATASTORE_READONLY_PASSWORD} 19 | - DATASTORE_DB=${DATASTORE_DB} 20 | volumes: 21 | - pg_data:/var/lib/postgresql/data 22 | restart: unless-stopped 23 | healthcheck: 24 | test: ["CMD", "pg_isready", "-U", "${POSTGRES_USER}", "-d", "${POSTGRES_DB}"] 25 | web: 26 | container_name: web 27 | build: 28 | context: . 29 | dockerfile: Dockerfile 30 | platform: linux/amd64 31 | depends_on: 32 | - solr 33 | - redis 34 | ports: 35 | - "5050:5000" 36 | env_file: 37 | - .env 38 | 39 | datapusher: 40 | container_name: datapusher 41 | image: ckan/ckan-base-datapusher:${DATAPUSHER_VERSION} 42 | ports: 43 | - "8800:8800" 44 | 45 | solr: 46 | image: ckan/ckan-solr:${CKAN_SOLR_VERSION} 47 | ports: 48 | - "8983:8983" 49 | volumes: 50 | - solr-data:/opt/solr/server/solr/ckan 51 | 52 | redis: 53 | image: redis:latest 54 | 55 | 56 | volumes: 57 | solr-data: {} 58 | ckan-filestore: {} 59 | pg_data: {} 60 | -------------------------------------------------------------------------------- /contrib/solr/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM solr:6.6.2 2 | MAINTAINER Open Knowledge 3 | 4 | ## Taken from https://github.com/ckan/ckan/blob/ckan-2.7.0/contrib/docker/solr/Dockerfile 5 | # Updated the ARG values 6 | ARG CKAN_VERSION=2.9.0 7 | 8 | # Enviroment 9 | ENV SOLR_CORE ckan 10 | 11 | # Create Directories 12 | RUN mkdir -p /opt/solr/server/solr/$SOLR_CORE/conf 13 | RUN mkdir -p /opt/solr/server/solr/$SOLR_CORE/data 14 | 15 | # Adding Files 16 | ADD https://raw.githubusercontent.com/ckan/ckan/ckan-${CKAN_VERSION}/contrib/docker/solr/solrconfig.xml \ 17 | https://raw.githubusercontent.com/ckan/ckan/ckan-${CKAN_VERSION}/ckan/config/solr/schema.xml \ 18 | https://raw.githubusercontent.com/apache/lucene-solr/releases/lucene-solr/6.6.2/solr/server/solr/configsets/basic_configs/conf/currency.xml \ 19 | https://raw.githubusercontent.com/apache/lucene-solr/releases/lucene-solr/6.6.2/solr/server/solr/configsets/basic_configs/conf/synonyms.txt \ 20 | https://raw.githubusercontent.com/apache/lucene-solr/releases/lucene-solr/6.6.2/solr/server/solr/configsets/basic_configs/conf/stopwords.txt \ 21 | https://raw.githubusercontent.com/apache/lucene-solr/releases/lucene-solr/6.6.2/solr/server/solr/configsets/basic_configs/conf/protwords.txt \ 22 | https://raw.githubusercontent.com/apache/lucene-solr/releases/lucene-solr/6.6.2/solr/server/solr/configsets/data_driven_schema_configs/conf/elevate.xml \ 23 | /opt/solr/server/solr/$SOLR_CORE/conf/ 24 | 25 | # Create Core.properties 26 | RUN echo name=$SOLR_CORE > /opt/solr/server/solr/$SOLR_CORE/core.properties 27 | 28 | # Giving ownership to Solr 29 | USER root 30 | RUN chown -R $SOLR_USER:$SOLR_USER /opt/solr/server/solr/$SOLR_CORE 31 | 32 | # User 33 | USER $SOLR_USER:$SOLR_USER 34 | -------------------------------------------------------------------------------- /.env.tmpl: -------------------------------------------------------------------------------- 1 | # For Paster commands 2 | CKAN_INI=/ckan.ini 3 | 4 | # Startup config 5 | # https://github.com/okfn/ckanext-envvars/issues/1#issuecomment-143709003 6 | CKAN_SQLALCHEMY_URL=postgres://ckan_default:pass@db/ckan_default 7 | CKAN_SITE_URL=http://localhost:5000 8 | CKAN_SOLR_URL=http://solr:8983/solr/ckan 9 | 10 | # Basic config 11 | CKAN___BEAKER__SESSION__SECRET= 12 | CKAN___APP_INSTANCE_UUID= 13 | 14 | # Database config 15 | CKAN_DATASTORE_WRITE_URL=postgres://ckan_default:pass@db/datastore_default 16 | CKAN_DATASTORE_READ_URL=postgres://datastore_default:pass@db/datastore_default 17 | 18 | CKAN_REDIS_URL=redis://redis:6379/0 19 | 20 | # Local storage config 21 | CKAN__STORAGE_PATH=/var/lib/ckan 22 | 23 | # S3 config 24 | CKANEXT__S3FILESTORE__AWS_ACCESS_KEY_ID= 25 | CKANEXT__S3FILESTORE__AWS_SECRET_ACCESS_KEY= 26 | CKANEXT__S3FILESTORE__AWS_BUCKET_NAME= 27 | CKANEXT__S3FILESTORE__HOST_NAME=https://s3-eu-west-1.amazonaws.com 28 | CKANEXT__S3FILESTORE__REGION_NAME=eu-west 29 | CKANEXT__S3FILESTORE__SIGNATURE_VERSION=s3v4 30 | CKANEXT__S3FILESTORE__AWS_STORAGE_PATH=dev 31 | 32 | # Datastore config 33 | CKAN__DATASTORE__WRITE_URL=postgresql://ckan_default:pass@db/datastore_default 34 | CKAN__DATASTORE__READ_URL=postgresql://datastore_default:pass@db/datastore_default 35 | 36 | # Sentry config 37 | CKAN_SENTRY_DSN= 38 | 39 | # reCAPTCHA 40 | CKAN_RECAPTCHA_PUBLIC_KEY="" 41 | CKAN_RECAPTCHA_PRIVATE_KEY="" 42 | 43 | # request timeout in X seconds 44 | CKAN_REQUESTS_TIMEOUT=30 45 | CKAN_RESOURCE_PROXY_TIMEOUT=30 46 | 47 | # Solr 48 | CKAN_SOLR_VERSION=2.11-solr9.8 49 | CKAN_SOLR_URL=http://solr:8983/solr/ckan 50 | TEST_CKAN_SOLR_URL=http://solr:8983/solr/ckan 51 | 52 | # Datapusher 53 | DATAPUSHER_VERSION=0.0.21 54 | CKAN_DATAPUSHER_URL=http://datapusher:8800 55 | CKAN__DATAPUSHER__CALLBACK_URL_BASE=http://ckan:5000 56 | DATAPUSHER_REWRITE_RESOURCES=True 57 | DATAPUSHER_REWRITE_URL=http://ckan:5000 58 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # Rope project settings 95 | .ropeproject 96 | 97 | # mkdocs documentation 98 | /site 99 | 100 | # mypy 101 | .mypy_cache/ 102 | 103 | 104 | # CKAN 105 | # !contrib/ckan/docker-entrypoint.d 106 | # ckan 107 | contrib/ckan/ckan.ini 108 | ckan-*.tar.gz 109 | # Env 110 | env* 111 | !env.tmpl 112 | 113 | # IDE 114 | .vscode/* 115 | -------------------------------------------------------------------------------- /contrib/ckan-datapusher/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM alpine:3.14 2 | 3 | ARG DATAPUSHER_VERSION=${DATAPUSHER_VERSION} 4 | ENV APP_DIR=/srv/app 5 | ENV GIT_URL https://github.com/ckan/datapusher.git 6 | ENV JOB_CONFIG ${APP_DIR}/datapusher_settings.py 7 | 8 | WORKDIR ${APP_DIR} 9 | 10 | RUN apk add --no-cache \ 11 | python3 \ 12 | py3-pip \ 13 | py3-wheel \ 14 | libffi-dev \ 15 | libmagic \ 16 | libressl-dev \ 17 | libxslt \ 18 | uwsgi \ 19 | uwsgi-http \ 20 | uwsgi-corerouter \ 21 | uwsgi-python \ 22 | # Temporary packages to build DataPusher requirements 23 | && apk add --no-cache --virtual .build-deps \ 24 | gcc \ 25 | git \ 26 | musl-dev \ 27 | python3-dev \ 28 | libxml2-dev \ 29 | libxslt-dev \ 30 | openssl-dev \ 31 | cargo 32 | 33 | RUN mkdir ${APP_DIR}/src && cd ${APP_DIR}/src && \ 34 | git clone -b ${DATAPUSHER_VERSION} --depth=1 --single-branch ${GIT_URL} && \ 35 | cd datapusher && \ 36 | python3 setup.py install 37 | 38 | COPY setup/requirements.txt ${APP_DIR}/src 39 | 40 | RUN cd ${APP_DIR}/src && \ 41 | pip3 install --no-cache-dir -r requirements.txt 42 | # pip3 install --no-cache-dir -r https://raw.githubusercontent.com/ckan/datapusher/${DATAPUSHER_VERSION}/requirements.txt 43 | 44 | RUN apk del .build-deps && \ 45 | cp ${APP_DIR}/src/datapusher/deployment/*.* ${APP_DIR} && \ 46 | # Remove default values in ini file 47 | sed -i '/http/d' ${APP_DIR}/datapusher-uwsgi.ini && \ 48 | sed -i '/wsgi-file/d' ${APP_DIR}/datapusher-uwsgi.ini && \ 49 | sed -i '/virtualenv/d' ${APP_DIR}/datapusher-uwsgi.ini && \ 50 | rm -rf ${APP_DIR}/src 51 | 52 | # Create a local user and group to run the app 53 | RUN addgroup -g 92 -S ckan && \ 54 | adduser -u 92 -h /srv/app -H -D -S -G ckan ckan 55 | 56 | USER ckan 57 | 58 | EXPOSE 8800 59 | CMD ["sh", "-c", \ 60 | "uwsgi --plugins=http,python --enable-threads --http=0.0.0.0:8800 --socket=/tmp/uwsgi.sock --ini=`echo ${APP_DIR}`/datapusher-uwsgi.ini --wsgi-file=`echo ${APP_DIR}`/datapusher.wsgi"] 61 | -------------------------------------------------------------------------------- /contrib/ckan/docker-entrypoint.d/openafrica_ckan.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | #OpenAfrica Custom 4 | if [[ $CKAN__PLUGINS == *"openafrica"* ]]; then 5 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.site_title="openAFRICA" 6 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.site_description='"Africa'\''s largest independent source for open data"' 7 | else 8 | echo "Not appliyng OpenAfrica customizations" 9 | fi 10 | 11 | #BS3 Templates 12 | # ckan config-tool ${CKAN_INI} -s app:main -e ckan.base_public_folder=public-bs3 13 | # ckan config-tool ${CKAN_INI} -s app:main -e ckan.base_templates_folder=templates-bs3 14 | 15 | #Auth settings 16 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.auth.create_user_via_web=true 17 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.auth.public_user_details=true 18 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.auth.create_default_api_keys=true 19 | 20 | #Auth settings, limit actions to sysadmin users 21 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.auth.user_create_organizations=false 22 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.auth.user_create_groups=false 23 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.auth.user_delete_groups=false 24 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.auth.user_delete_organizations=false 25 | 26 | 27 | #Dataset Settings 28 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.auth.public_activity_stream_detail=true 29 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.auth.allow_dataset_collaborators=false 30 | 31 | # Customize which text formats the text_view plugin will show 32 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.preview.json_formats='json' 33 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.preview.xml_formats='xml rdf rdf+xml owl+xml atom rss' 34 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.preview.text_formats='text plain text/plain' 35 | 36 | # Customize which image formats the image_view plugin will show 37 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.preview.image_formats='png jpeg jpg gif' 38 | 39 | # reCAPTCHA 40 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.recaptcha.publickey=${CKAN_RECAPTCHA_PUBLIC_KEY} 41 | ckan config-tool ${CKAN_INI} -s app:main -e ckan.recaptcha.privatekey=${CKAN_RECAPTCHA_PRIVATE_KEY} 42 | 43 | # Site Settings 44 | 45 | # Default requests.timeout value 5 seconds 46 | ckan config-tool ${CKAN_INI} -s app:main ckan.requests.timeout=${CKAN_REQUESTS_TIMEOUT} 47 | ckan config-tool ${CKAN_INI} -s app:main ckan.resource_proxy.timeout=${CKAN_RESOURCE_PROXY_TIMEOUT} 48 | 49 | ckan config-tool ${CKAN_INI} -s DEFAULT "debug = false" 50 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ckan/ckan-base:2.11 2 | # Install any extensions needed by your CKAN instance 3 | # - Make sure to add the plugins to CKAN__PLUGINS in the .env file 4 | # - Also make sure all provide all extra configuration options, either by: 5 | # * Adding them to the .env file (check the ckanext-envvars syntax for env vars), or 6 | # * Adding extra configuration scripts to /docker-entrypoint.d folder) to update 7 | # the CKAN config file (ckan.ini) with the `ckan config-tool` command 8 | # 9 | # See README > Extending the base images for more details 10 | # 11 | 12 | # https://github.com/ckan/ckan-docker/issues/196 13 | USER root 14 | RUN mkdir /srv/app/.local && chown ckan /srv/app/.local 15 | USER ckan 16 | 17 | ### OpenAfrica ### 18 | RUN pip3 install -e git+https://github.com/CodeForAfrica/ckanext-openafrica.git#egg=ckanext-openafrica 19 | 20 | ### Datarequests 21 | RUN pip3 install -e git+https://github.com/CodeForAfrica/ckanext-datarequests.git#egg=ckanext-datarequests 22 | 23 | ### Harvester ### 24 | RUN pip3 install -e git+https://github.com/ckan/ckanext-harvest.git#egg=ckanext-harvest && \ 25 | pip3 install -r ${APP_DIR}/src/ckanext-harvest/pip-requirements.txt 26 | 27 | ## s3filestore 28 | RUN pip3 install -e git+https://github.com/qld-gov-au/ckanext-s3filestore.git#egg=ckanext-s3filestore && \ 29 | pip3 install -r ${APP_DIR}/src/ckanext-s3filestore/requirements.txt 30 | 31 | ## ckan GoogleAnalytics 32 | RUN pip3 install -e git+https://github.com/ckan/ckanext-googleanalytics.git#egg=ckanext-googleanalytics && \ 33 | pip3 install -r ${APP_DIR}/src/ckanext-googleanalytics/requirements.txt 34 | 35 | ## ckanext-showcase 36 | RUN pip3 install -e git+https://github.com/ckan/ckanext-showcase.git#egg=ckanext-showcase && \ 37 | pip3 install -r ${APP_DIR}/src/ckanext-showcase/requirements.txt 38 | 39 | 40 | # Copy custom initialization scripts 41 | COPY contrib/ckan/docker-entrypoint.d/* /docker-entrypoint.d/ 42 | 43 | ENV APP_DIR=/srv/app 44 | # Install any extensions needed by your CKAN instance 45 | ### Harvester ### 46 | RUN pip3 install -e git+https://github.com/ckan/ckanext-harvest.git#egg=ckanext-harvest && \ 47 | pip3 install -r ${APP_DIR}/src/ckanext-harvest/pip-requirements.txt 48 | 49 | ## s3filestore 50 | RUN pip3 install -e git+https://github.com/qld-gov-au/ckanext-s3filestore.git#egg=ckanext-s3filestore && \ 51 | pip3 install -r ${APP_DIR}/src/ckanext-s3filestore/requirements.txt 52 | 53 | ## ckan GoogleAnalytics 54 | RUN pip3 install -e git+https://github.com/ckan/ckanext-googleanalytics.git#egg=ckanext-googleanalytics && \ 55 | pip3 install -r ${APP_DIR}/src/ckanext-googleanalytics/requirements.txt 56 | 57 | ## ckanext-showcase 58 | RUN pip3 install -e git+https://github.com/ckan/ckanext-showcase.git#egg=ckanext-showcase && \ 59 | pip3 install -r ${APP_DIR}/src/ckanext-showcase/requirements.txt 60 | 61 | # Copy custom initialization scripts for production 62 | COPY contrib/ckan/docker-entrypoint.d/* /docker-entrypoint.d/ 63 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | 3 | You are here to help on [openAFRICA](https://africaopendata.org) deployment? Awesome, feel welcome and read the following 4 | sections in order to know what and how to work on something. If you get stuck 5 | at any point you can create a ticket on 6 | [GitHub](https://github.com/CodeForAfricaLabs/openAFRICA/issues/). 7 | 8 | All members of our community are expected to follow our 9 | [Code of Conduct](https://github.com/CodeForAfrica/CodeOfConduct). Please make 10 | sure you are welcoming and friendly in all of our spaces. 11 | 12 | Following these guidelines helps to communicate that you respect the time of 13 | the developers managing and developing this open source project. In return, 14 | they should reciprocate that respect in addressing your issue, assessing 15 | changes, and helping you finalize your pull requests. 16 | 17 | ## Types of Contributions 18 | 19 | You can contribute in many ways. For example, you might: 20 | * Add documentation and "how-to" articles in the [README](README.md) or the wiki 21 | * Suggest Enhancements 22 | * Fix issues 23 | * Submit Bug reports 24 | 25 | #### Bug Reports 26 | *If you find a security vulnerability, **DO NOT** open an issue. Email 27 | [security@codeforafrica.org](mailto:security@codeforafrica.org) instead.* 28 | 29 | If you're reporting a bug, please include: 30 | * Your operating system name and version 31 | * Any details about your local setup that might be helpful in troubleshooting. 32 | * If you can, provide detailed steps to reproduce the bug. 33 | * If you don't have steps to reproduce the bug, just note your observations in 34 | as much detail as you can. Questions to start a discussion about the issue 35 | are welcome. 36 | 37 | To ease the process of reporting bugs and issues, consider using our 38 | [issue template](https://github.com/CodeForAfricaLabs/openAFRICA/blob/master/.github/ISSUE_TEMPLATE.md) 39 | and don't forget to add an appropriate 40 | [label](https://help.github.com/articles/creating-a-label/) to the issue. 41 | 42 | #### Writing Documentation 43 | Did you find a typo? Do you think that something should be clarified? Go ahead 44 | and suggest a documentation patch. The openAFRICA deployment could always use more documentation, 45 | whether as part of the official docs, in docstrings, or even on the web in blog 46 | posts, wiki, articles, and such. 47 | 48 | #### Fixing Issues 49 | Look through the GitHub issues for bugs. Anything tagged with "bug" is open to 50 | whoever wants to implement it. 51 | 52 | #### Suggesting Enhancements 53 | 54 | Before creating enhancement suggestions, please check the issues list as you 55 | might find out that you don't need to create one. When you are creating an 56 | enhancement suggestion fill out the 57 | [issue template](https://github.com/CodeForAfricaLabs/openAFRICA/blob/master/.github/ISSUE_TEMPLATE.md) 58 | and [label](https://help.github.com/articles/creating-a-label/) the issue as a 59 | new feature. 60 | 61 | ## Your first contribution 62 | 63 | Unsure where to begin contributing to openAFRICA? You can start by looking through 64 | these `beginner` and `help-wanted` issues: 65 | 66 | * `Beginner issues` - issues which should only require a few lines of code, and a 67 | test or two. 68 | * `Help wanted issues` - issues which should be a bit more involved than beginner 69 | issues. 70 | 71 | Once your changes and tests are ready to submit for review: 72 | 73 | 1. Test your changes 74 | 75 | Run the tests if you have any and at the bare minimum, test your changes 76 | manually. 77 | 78 | 2. Rebase your changes 79 | 80 | Update your local repository with the most recent code from the main openAFRICA 81 | repository, and rebase your branch on top of the latest develop branch. 82 | 83 | 3. Submit a pull request 84 | 85 | Push your local changes to your forked copy of the repository and submit a 86 | pull request. In the pull request, choose a title which sums up the changes 87 | that you have made, and in the body provide more details about what your 88 | changes do. Also mention the number of the issue where discussion has taken 89 | place. Preferably use our 90 | [PR template](https://github.com/CodeForAfricaLabs/openAFRICA/blob/master/.github/PULL_REQUEST_TEMPLATE.md). 91 | 92 | Then sit back and wait. There will probably be discussion about the pull 93 | request and, if any changes are needed, we would love to work with you to 94 | get your pull request merged into openAFRICA. 95 | 96 | ## Code Style 97 | 98 | Please adhere to the [PEP8](https://www.python.org/dev/peps/pep-0008/) Coding 99 | conventions for the Python language. This style guide evolves over time as 100 | additional conventions are identified and past conventions are rendered obsolete 101 | by changes in the language itself. Ensure to keep updated. 102 | 103 | ## Ground Rules 104 | The goal is to maintain a diverse community that's pleasant for everyone. 105 | That's why we would greatly appreciate it if everyone contributing to and 106 | interacting with the community also followed this 107 | [Code of Conduct](https://github.com/CodeForAfrica/CodeOfConduct). 108 | The [Code of Conduct](https://github.com/CodeForAfrica/CodeOfConduct) covers our 109 | behavior as members of the community, in any forum, mailing list, wiki, website, 110 | Internet relay chat (IRC), public meeting or private correspondence. 111 | 112 | 113 | 114 | Please see [contribution-guide.org](http://www.contribution-guide.org) for details on what we expect from contributors. Thanks! -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | [openAFRICA](https://open.africa/) community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all [openAFRICA](https://open.africa/) community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing the community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | data@codeforafrica.org. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # openAFRICA 2 | *The continent's largest volunteer-driven open data portal.* 3 | 4 | ![CKAN version](https://img.shields.io/badge/CKAN-v2.6.8-brightgreen.svg) 5 | 6 | This repo seeks to streamline deployment of the openAFRICA platform by pulling together the different components used for [openAFRICA](https://openafrica.net/) and deploy using [dokku](http://dokku.viewdocs.io/dokku/). 7 | 8 | ## CKAN 9 | 10 | CKAN is an open-source DMS (data management system) for powering data hubs and data portals. CKAN makes it easy to publish, share and use data. It powers datahub.io, catalog.data.gov and data.gov.uk among many other sites. 11 | 12 | We use CKAN's own vanilla releases but because they haven't properly adopted Docker and dockerhub (yet) for deployment, we're keeping a stable version (`codeforafrica/ckan:latest`) that we can be sure plays nice with our extenstions. 13 | 14 | The ckan extensions we are using include: 15 | 16 | - ckanext-openafrica - https://github.com/CodeForAfrica/ckanext-openafrica 17 | - ckanext-datarequests - https://github.com/conwetlab/ckanext-datarequests 18 | - ckanext-harvester - https://github.com/ckan/ckanext-harvest 19 | - ckanext-s3filestore - https://github.com/okfn/ckanext-s3filestore 20 | - ckanext-showcase - https://github.com/ckan/ckanext-showcase 21 | - ckanext-googleanalytics - https://github.com/ckan/ckanext-googleanalytics 22 | - ckanext-issues - https://github.com/ckan/ckanext-issues 23 | - ckanext-gdoc - https://github.com/OpenUpSA/ckanext-gdoc 24 | - ckanext-envvars - https://github.com/okfn/ckanext-envvars/ 25 | 26 | 27 | --- 28 | 29 | ## Development 30 | 31 | 32 | To set up your development environment: 33 | 34 | ```sh 35 | $ git clone https://github.com/CodeForAfricaLabs/openAFRICA.git 36 | 37 | $ cd openAFRICA 38 | ``` 39 | 40 | Run this command (found on the docker-compose.yml): 41 | 42 | ```sh 43 | docker-compose build && docker-compose up 44 | ``` 45 | 46 | ### Updating CKAN Docker Image 47 | 48 | To update the `openafrica/ckan:latest` Docker image, edit `Makefile` and then run: 49 | 50 | ```sh 51 | make ckan 52 | ``` 53 | 54 | ### Tests 55 | 56 | ? 57 | 58 | --- 59 | 60 | ## Deployment 61 | 62 | We use [dokku](http://dokku.viewdocs.io/dokku/) for deployment so you'd need to install and set it up first; 63 | 64 | ``` 65 | # for debian systems, installs dokku via apt-get 66 | $ wget https://raw.githubusercontent.com/dokku/dokku/v0.11.3/bootstrap.sh 67 | $ sudo DOKKU_TAG=v0.11.3 bash bootstrap.sh 68 | # go to your server's IP and follow the web installer 69 | ``` 70 | 71 | 72 | ### Install + Create Dependencies 73 | 74 | Once installed, we can do the following: 75 | 76 | 1. Create the Dokku app and add a domain to it 77 | 78 | ``` 79 | dokku apps:create ckan 80 | dokku domains:add ckan openafrica.net 81 | ``` 82 | 83 | 2. Add letsencrypt for free `https` certificate 84 | 85 | Install the [dokku-letsencrypt](https://github.com/dokku/dokku-letsencrypt) plugin and set the config variables 86 | 87 | ``` 88 | sudo dokku plugin:install https://github.com/dokku/dokku-letsencrypt.git 89 | dokku config:set --no-restart ckan DOKKU_LETSENCRYPT_EMAIL=support@codeforafrica.org 90 | ``` 91 | 92 | 3. Create CKAN Solr Instance 93 | 94 | CKAN uses a special schema for Solr so you should deploy `openafrica/solr` 95 | 96 | ``` 97 | dokku apps:create ckan-solr 98 | 99 | sudo docker volume create --name ckan-solr 100 | dokku docker-options:add ckan-solr run,deploy --volume ckan-solr:/opt/solr/server/solr/ckan 101 | 102 | sudo docker pull codeforafrica/ckan-solr:2.7.6 103 | sudo docker tag codeforafrica/ckan-solr:2.7.6 dokku/ckan-solr:latest 104 | 105 | dokku git:from-image ckan-solr dokku/ckan-solr:latest 106 | 107 | ``` 108 | 109 | 4. Create Redis Instance 110 | 111 | Install the [redis](https://github.com/dokku/dokku-redis) plugin. 112 | 113 | ``` 114 | sudo dokku plugin:install https://github.com/dokku/dokku-redis.git redis 115 | dokku redis:create ckan-redis 116 | 117 | ``` 118 | 119 | 5. Create CKAN DataPusher Instance 120 | 121 | [DataPusher](https://github.com/ckan/datapusher) is a standalone web service that automatically downloads any CSV or XLS (Excel) data files from a CKAN site's resources when they are added to the CKAN site, parses them to pull out the actual data, then uses the DataStore API to push the data into the CKAN site's DataStore. 122 | 123 | ``` 124 | dokku apps:create ckan-datapusher 125 | 126 | sudo docker pull openafrica/ckan-datapusher:latest 127 | sudo docker tag openafrica/ckan-datapusher:latest dokku/ckan-datapusher:latest 128 | 129 | dokku git:from-image ckan-datapusher dokku/ckan-datapusher:latest 130 | 131 | ``` 132 | 133 | 6. Install Postgres (Optional) 134 | 135 | This is an optional step if you'd like to have Postgres installed locally; 136 | 137 | ``` 138 | sudo dokku plugin:install https://github.com/dokku/dokku-postgres.git postgres 139 | dokku postgres:create ckan-postgres 140 | 141 | ``` 142 | 143 | 7. Install RabbitMQ 144 | 145 | Install the [RabbitMQ](https://github.com/dokku/dokku-rabbitmq) plugin (The harvest extension uses this as its backend) 146 | 147 | ``` 148 | sudo dokku plugin:install https://github.com/dokku/dokku-rabbitmq.git rabbitmq 149 | dokku rabbitmq:create ckan-rabbitmq 150 | ``` 151 | 152 | 8. Set up S3 153 | 154 | Create a bucket and a programmatic access user, and grant the user full access to the bucket with the following policy 155 | 156 | ``` 157 | { 158 | "Version": "2012-10-17", 159 | "Statement": [ 160 | { 161 | "Effect": "Allow", 162 | "Action": [ 163 | "s3:*" 164 | ], 165 | "Resource": [ 166 | "arn:aws:s3:::openafrica/*", 167 | "arn:aws:s3:::openafrica" 168 | ] 169 | } 170 | ] 171 | } 172 | ``` 173 | 174 | 9. Create CKAN filestore volume 175 | 176 | Create a named docker volume and configure ckan to use the volume just so we can configure an upload path. It should be kept clear by the s3 plugin. 177 | 178 | ``` 179 | sudo docker volume create --name ckan-filestore 180 | dokku docker-options:add ckan run,deploy --volume ckan-filestore:/var/lib/ckan/default 181 | ``` 182 | 183 | ### Configuration 184 | 185 | Now we configure to pull the dependencies together: 186 | 187 | Get the Redis Dsn (connection details) for setting in CKAN environment in the next step with /0 appended. 188 | 189 | ``` 190 | dokku redis:info ckan-redis 191 | ``` 192 | Get the RabbitMQ Dsn (connection details) and extract the `username`, `password`, `hostname`, `virtualhost` and `port`. You need these details because the harvester extension in its current form does not support configuration using RabbitMQ URI scheme. The URI is in the form 193 | 194 | ``` 195 | amqp://username:password@hostname:port/virtualhost 196 | ``` 197 | 198 | 199 | Set CKAN environment variables, replacing these examples with actual producation ones 200 | 201 | - REDIS_URL: use the Redis Dsn 202 | - SOLR_URL: use the alias given for the docker link below 203 | - BEAKER_SESSION_SECRET: this must be a secret long random string. Each time it changes it invalidates any active sessions. 204 | - S3FILESTORE__SIGNATURE_VERSION: use as-is - no idea why the plugin requires this. 205 | 206 | 207 | ``` 208 | dokku config:set ckan CKAN_SQLALCHEMY_URL=postgres://ckan_default:password@host/ckan_default \ 209 | CKAN_DATASTORE_READ_URL=postgresql://ckan_default:pass@localhost/datastore_default \ 210 | CKAN_DATASTORE_WRITE_URL=postgresql://datastore_default:pass@localhost/datastore_default \ 211 | CKAN_REDIS_URL=.../0 \ 212 | CKAN_INI=/ckan.ini \ 213 | CKAN_SOLR_URL=http://solr:8983/solr/ckan \ 214 | CKAN_SITE_URL=https://openafrica.net/ \ 215 | CKAN___BEAKER__SESSION__SECRET= \ 216 | CKAN_SMTP_SERVER= \ 217 | CKAN_SMTP_USER= \ 218 | CKAN_SMTP_PASSWORD= \ 219 | CKAN_SMTP_MAIL_FROM=hello@openafrica.net \ 220 | CKAN___CKANEXT__S3FILESTORE__AWS_BUCKET_NAME=openafrica \ 221 | CKAN___CKANEXT__S3FILESTORE__AWS_ACCESS_KEY_ID= \ 222 | CKAN___CKANEXT__S3FILESTORE__AWS_SECRET_ACCESS_KEY= \ 223 | CKAN___CKANEXT__S3FILESTORE__HOST_NAME=http://s3-eu-west-1.amazonaws.com \ 224 | CKAN___CKANEXT__S3FILESTORE__REGION_NAME=eu-west-1 \ 225 | CKAN___CKANEXT__S3FILESTORE__SIGNATURE_VERSION=s3v4 \ 226 | CKAN__HARVEST__MQ__VIRTUAL_HOST=ckan-rabbitmq \ 227 | CKAN__HARVEST__MQ__PORT=5672 \ 228 | CKAN__HARVEST__MQ__HOSTNAME=dokku-rabbitmq-ckan-rabbitmq \ 229 | CKAN__HARVEST__MQ__PASSWORD=912abee9882be7ca8718d3cab7263cfd \ 230 | CKAN__HARVEST__MQ__USER_ID=ckan-rabbitmq \ 231 | ``` 232 | 233 | Link CKAN with Redis, Solr, and CKAN DataPusher; 234 | ``` 235 | dokku redis:link ckan-redis ckan #noqa 236 | dokku docker-options:add ckan run,deploy --link ckan-solr.web.1:solr 237 | dokku docker-options:add ckan run,deploy --link ckan-datapusher.web.1:ckan-datapusher 238 | ``` 239 | 240 | ### Scheduled Jobs 241 | For openAFRICA to work perfectly, some jobs have to run at certain times e.g. updating tracking statistics and rebuilding the search index for newly uploaded datasets. To create a scheduled job that is executed by a Dokku application, follow these steps: 242 | 243 | ```sh 244 | sudo su dokku 245 | crontab -e 246 | ``` 247 | 248 | Add the following entries 249 | 250 | ```sh 251 | 0 * * * * echo '{}' | dokku --rm run ckan paster --plugin=ckan post -c /ckan.ini /api/action/send_email_notifications > /dev/null 252 | 253 | 0 * * * * dokku --rm run ckan paster --plugin=ckan tracking update -c /ckan.ini 254 | 255 | */15 * * * * dokku --rm run ckan paster --plugin=ckanext-harvest harvester run --config=/ckan.ini 256 | ``` 257 | 258 | ### Deploy CKAN 259 | 260 | 261 | Once done with installing and configuring, you can push this repository to dokku: 262 | 263 | ``` 264 | git remote add dokku dokku@openafrica.net:ckan 265 | git push dokku 266 | ``` 267 | 268 | ### Initialize Database 269 | 270 | Before you can run CKAN for the first time, you need to run `db init` to initialize your database 271 | 272 | ``` 273 | dokku enter ckan 274 | cd src/ckan 275 | paster db init -c /ckan.ini 276 | ``` 277 | 278 | Lastly, let's make sure we encrypt traffic: 279 | 280 | ``` 281 | dokku letsencrypt ckan 282 | ``` 283 | 284 | 285 | ***NOTE:** Make sure to have the [appropriate permissions to push to dokku](http://dokku.viewdocs.io/dokku/deployment/user-management/).* 286 | 287 | --- 288 | 289 | ## Contributing 290 | 291 | Thank you for considering to contribute to this project. You are awesome. :) 292 | 293 | To get you started, here are few pointers: 294 | 295 | - We have a number of Github issues to work through here: 296 | - openAFRICA deploy: https://github.com/CodeForAfricaLabs/openAFRICA/issues 297 | - ckanext-openafrica: https://github.com/CodeForAfrica/ckanext-openafrica/issues 298 | - ckanext-socialite: https://github.com/CodeForAfricaLabs/ckanext-socialite/issues 299 | - ckanext-social: https://github.com/CodeForAfricaLabs/ckanext-social/issues 300 | - If you believe an issue is with CKAN core or related extenstions, post them here: 301 | - CKAN core: https://github.com/ckan/ckan/issues 302 | - ckanext-harvester: ? 303 | 304 | Check out the [development docs](#development) to get started on this repo locally. 305 | 306 | 307 | ### Security Vulnerabilities 308 | 309 | Please report on security vulnerabilities to security@codeforafrica.org. These will be promptly acted on. 310 | 311 | --- 312 | 313 | ## License 314 | 315 | GNU General Public License 316 | 317 | openAFRICA aims to be the largest independent repository of open data on the African continent. 318 | Copyright (C) 2017 Code for Africa 319 | 320 | This program is free software: you can redistribute it and/or modify 321 | it under the terms of the GNU General Public License as published by 322 | the Free Software Foundation, either version 3 of the License, or 323 | (at your option) any later version. 324 | 325 | This program is distributed in the hope that it will be useful, 326 | but WITHOUT ANY WARRANTY; without even the implied warranty of 327 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 328 | GNU General Public License for more details. 329 | 330 | You should have received a copy of the GNU General Public License 331 | along with this program. If not, see . 332 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | --------------------------------------------------------------------------------