Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
atodorov committed Oct 9, 2017
1 parent 38088ac commit fbd3226
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 10 deletions.
2 changes: 2 additions & 0 deletions docs/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ need to be configured via the following settings::
If you'd like to use an external email service, like Amazon SES you have to
configure the following settings instead::

EMAIL_HOST = 'example.com'
EMAIL_FROM = 'kiwi@example.com'
DEFAULT_FROM_EMAIL = EMAIL_FROM
EMAIL_BACKEND = 'django_ses.SESBackend'
AWS_SES_ACCESS_KEY_ID = 'xxxxxxxxxxxxxxxxxxxx'
AWS_SES_SECRET_ACCESS_KEY = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'
Expand Down
81 changes: 73 additions & 8 deletions docs/source/installing_docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,79 @@ You can build a Docker image of Kiwi TCMS by running::

This will create a Docker image based on the official CentOS 7 image
with the latest Kiwi TCMS version. By default the image tag will be
``mrsenko/kiwi:<version>``.
``kiwitcms/kiwi:<version>``.


Create Docker container
-----------------------
Start Docker compose
--------------------

Please see the `kiwi-docker <https://github.com/MrSenko/kiwi-docker>`_
repository for information about running Kiwi TCMS as a Docker container
and doing customizations. The repo allows you to change all Django related
settings in ``product.py`` as well as produce fine-tuned Docker images on your
own.
You can start using Kiwi TCMS by executing::

docker-compose up -d


Your Kiwi TCMS instance will be accessible at https://localhost.

The above command will create two containers:

1) A web container based on the latest Kiwi TCMS image
2) A DB container based on the official centos/mariadb image


``docker-compose`` will also create two volumes for persistent data storage:
``kiwi_db_data`` and ``kiwi_uploads``.


Initial configuration of running container
------------------------------------------

You need to do initial configuration by executing::

docker exec -it kiwi_web /Kiwi/manage.py migrate
docker exec -it kiwi_web /Kiwi/manage.py createsuperuser

This will create the database schema and create the first user in the system!


Upgrading
---------

To upgrade running Kiwi TCMS containers execute the following commands::

docker-compose down
docker pull kiwitcms/kiwi # to fetch latest version from Docker.io
docker-compose up -d
docker exec -it kiwi_web /Kiwi/manage.py migrate

.. note:
Uploads and database data should stay intact because they are split into
separate volumes, which makes upgrading very easy. However you may want to
back these up before upgrading!
SSL configuration
-----------------

By default Kiwi TCMS is served via HTTPS. This docker compose is configured with
a default self-signed certificate. If you want to use a different SSL certificate
you need to update the ``kiwi-https.key`` and ``kiwi-https.crt`` files! More information
about generating your own self-signed certificates can be found at
https://wiki.centos.org/HowTos/Https.


Customization
-------------

You can configure your ``docker-compose.yml`` to mount a local file
``my_settings.py`` inside the running Docker container as ``product.py``.
You can override any default settings in this way!

You can also build your own customized version of Kiwi TCMS by adjusting
the contents of the local ``Dockerfile``. Use that file to install additional
Python dependencies you may need and then::

docker build -t my_org/my_kiwi:<version> .

Next make sure to modify ``docker-compose.yml`` to use your customized image
instead the default ``kiwitcms/kiwi:latest``!
2 changes: 1 addition & 1 deletion docs/source/support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ Support

Commercial support for Kiwi TCMS is available from
`Mr. Senko <http://MrSenko.com>`_. For more information, pricing and support
levels info see http://MrSenko.com/kiwi/.
levels info see http://MrSenko.com/.
2 changes: 1 addition & 1 deletion tcms/settings/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@


# Email settings
# See http://docs.djangoproject.com/en/dev/ref/settings/#email-backend
# EMAIL_HOST must be defined if you want Kiwi TCMS to send emails
EMAIL_HOST = ''
EMAIL_PORT = 25
EMAIL_FROM = 'kiwi@example.com'
Expand Down

0 comments on commit fbd3226

Please sign in to comment.