diff --git a/CHANGELOG b/CHANGELOG index 014132c37c6560b3ff35f5beec33090815cf354f..0b229b0799a603a1a640260ebe12f39d2ec66407 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,10 +1,18 @@ -uffd (0.3.0) unstagle; urgency=medium +uffd (0.3.0) unstable; urgency=medium + [ nd ] * update link to rocketchat in README * add uffd-admin command, cleanup cronjob and needed /run folder * move package build dependencies to docker image * enable uwsgi app by default and add maintainer script to restart uwsgi * move python dependencies from requirements.txt to setup.py + * update changelog for 0.3.0 release + * add more warnings against using pip install for production setups + * add comment why we ignore the package dependencies extracted by pybild + * removed not needed sleep from tests + + [ Julian ] + * ensure uffd-admin works with arguments containing whitespace -- CCCV <it@cccv.de> Sat, 31 Jul 2021 23:36:01 +0000 diff --git a/README.md b/README.md index 8c0fd44d193d26ffff517c371137e9f674a62182..4efd31b5197b872efe38ffafb4b25136c22b0859 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Development chat: [#uffd-development](https://rocket.cccv.de/channel/uffd-develo ## Dependencies -Please note that we refere to debian packages here and **not** pip packages. +Please note that we refer to Debian packages here and **not** pip packages. - python3 - python3-ldap3 @@ -41,12 +41,13 @@ Please note that the mocked LDAP functionality is very limited and many uffd fea ## Deployment -You should absolutly never use `pip install uffd` to deploy to production. Using a pip deployment for production will result in not updated dependencies is insecure. -Our pip dependencies are not regularly updated and neither tested. They just represent the version Debian based their packages on. -Instead we relay on the packaged Debian python packages and security updates done by Debian. -The pip package mainly exists for testing and as a required step to build the .deb package. +You should absolutely never use `pip install uffd` for production deployments. +The dependencies of the pip package roughly represent the versions shipped by Debian stable. +We do not keep them updated and we do not test the pip package! +The pip package only exists for local testing/development and to help build the Debian package. -To deploy to production, use our .deb package. It uses uwsgi to run uffd and ships an `uffd-admin` to execute flask commands in the correct context. +To deploy to production, use our Debian package. You will get security updates for all dependencies from Debian. +The Debian package uses uwsgi to run uffd and ships an `uffd-admin` to execute flask commands in the correct context. If you upgrade, make sure to run `flask db upgrade` after every update! The Debian package takes care of this by itself using uwsgi pre start hooks. For an example uwsgi config, see our [uswgi.ini](uwsgi.ini). You might find our [nginx include file](nginx.include.conf) helpful to setup a web server in front of uwsgi.