Skip to content

Commit

Permalink
Document the build process. Fixes #89
Browse files Browse the repository at this point in the history
  • Loading branch information
atodorov committed Jun 16, 2021
1 parent 0674ada commit 83b262a
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,32 @@ https://kiwitcms.readthedocs.io/en/latest/installing_docker.html#initial-configu
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
---------
Expand Down

0 comments on commit 83b262a

Please sign in to comment.