Kiwi TCMS Enterprise Edition

This repository contains downstream distribution for the Kiwi TCMS open source test management system, dubbed Enterprise Edition, which contains the following changes:

• Based on kiwitcms/kiwi Docker image
• Compatible only with PostgreSQL !!!
• Versioned static files
• Add-ons:
  • django-ses - Amazon SES email backend
  • dj-database-url - DB configuration via DATABASE_URL
  • kiwitcms-github-app - extra integration with GitHub
  • kiwitcms-tenants - multi-tenant support
  • raven - automatic error logs via Sentry
  • social-auth-app-django - extra authentication backends
  • social-auth-kerberos - MIT Kerberos authentication backend
  • django-python3-ldap - LDAP authentication backend

While the software itself is open source we do not provide public access to the resulting kiwitcms/enterprise container image. This is made available only to our subscribers, see https://kiwitcms.org/containers/ and https://kiwitcms.org/#subscriptions for more information.

If you want to use Kiwi TCMS free of charge head to http://kiwitcms.org!

Initial configuration

1. Create your docker-compose.yml similar to our docker-compose.testing. Make sure to define the KIWI_TENANTS_DOMAIN environment variable.

2. Once your containers are running execute:

   docker exec -it kiwi_web /Kiwi/manage.py initial_setup
   docker exec -it kiwi_web /Kiwi/manage.py create_tenant --schema_name public
                                                          --name "Main tenant"
                                                          --paid_until 2050-12-31
                                                          --publicly_readable False
                                                          --owner_id 2
                                                          --organization "Testing department"
                                                          --domain-domain main.tenants.example.org
                                                          --domain-is_primary True
   

   NOTE: the value of --domain-domain is either the same or one-level up from the value of KIWI_TENANTS_DOMAIN.

For more information see https://kiwitcms.readthedocs.io/en/latest/installing_docker.html#initial-configuration-of-running-container and https://github.com/kiwitcms/tenants/#first-boot-configuration

Hacking and customization

In case you need to customize and extend the container image we recommend to use the existing image as a baseline and incorporate all of your changes on top of it. For example create a Dockerfile like so:

FROM quay.io/kiwitcms/enterprise

# your own changes go here

then build your own image with the command docker build -f Dockerfile.customized -t kiwitcms/customized ..

Rebuilding from source is not recommended b/c it will result in slightly different images compared to what we provide online to subscribers. There is no way for the Kiwi TCMS team to test or provide any guarantees on container images rebuilt by anyone but us!

In the event that you need to do so then use the make docker-image command and watchout for errors during the build process. The buildroot generally needs Python 3, the make and docker commands, the wheel and twine Python packages.

Changelog

v10.1-mt (18 May 2021)

• Based on Kiwi TCMS v10.1
• Container image built with Python 3.8
• Update kiwitcms-tenants from 1.4.3 to 1.4.4

v10.0.1-mt (29 Apr 2021)

• Based on Kiwi TCMS v10.0
• Update django-ses from 1.0.3 to 2.0.0
• Add python3-saml to dependencies, needed by Python Social Auth SAML backend

v10.0-mt (02 Mar 2021)

• Based on Kiwi TCMS v10.0
• Update kiwitcms-github-app from 1.2.2 to 1.2.4
• Update kiwitcms-tenants from 1.4.2 to 1.4.3
• Update django-python3-ldap from 0.11.3 to 0.11.4

v9.0-mt (12 Jan 2021)

• Based on Kiwi TCMS v9.0
• Update kiwitcms-github-app from 1.2.1 to 1.2.2
• Update kiwitcms-tenants from 1.3.1 to 1.4.2

v8.9-mt (07 Dec 2020)

• Based on Kiwi TCMS v8.9

v8.8-mt (07 Nov 2020)

• Based on Kiwi TCMS v8.8
• Update kiwitcms-github-app from 1.2 to 1.2.1

v8.7-mt (16 Sep 2020)

• Based on Kiwi TCMS v8.7
• Overrides for setting PUBLIC_VIEWS have been removed b/c this setting has been removed upstream
• Update django-ses from 1.0.2 to 1.0.3
• Update kiwitcms-github-app from 1.1 to 1.2
• Update kiwitcms-tenants from 1.2.1 to 1.3.1

v8.6-mt (23 Aug 2020)

• Based on Kiwi TCMS v8.6

v8.5.2-mt (06 Aug 2020)

• Update django-ses from 1.0.1 to 1.0.2
• Update kiwitcms-github-app from 1.0 to 1.1

v8.5.1-mt (24 July 2020)

• Based on Kiwi TCMS v8.5
• Update kiwitcms-tenants from 1.2 to 1.2.1

v8.5-mt (10 July 2020)

• Based on Kiwi TCMS v8.5
• Update django-ses from 0.8.14 to 1.0.1
• Update kiwitcms-tenants from 1.1.1 to 1.2
• Update social-auth-app-django from 3.4.0 to 4.0.0
• Start tagging non-Enterprise images of kiwitcms/kiwi - will be provided via separate private repository for enterprise customers

v8.4-mt (03 June 2020)

• Based on Kiwi TCMS v8.4
• Update social-auth-app-django from 3.1.0 to 3.4.0
• Add django-python3-ldap add-on for LDAP logins

v8.3-mt (27 Apr 2020)

• Convert into a proper Kiwi TCMS plugin before installing into docker image
• Update kiwitcms-tenants from 1.0.1 to 1.1.1
• Ship with kiwitcms-github-app plugin
• Add icon for kerberos login backend
• Add translation source strings
• Add tcms_settings_dir/ like other plugins
• Make enterprise.py settings idempotent
• Update LICENSE to GPLv3
• Fix pyllint issues
• Add tests in CI