otterwiki 2.2.0__tar.gz

otterwiki-2.2.0/.coveragerc

@@ -0,0 +1,6 @@
+[run]
+omit =
+    otterwiki/profiler.py
+
+[html]
+directory = coverage_html

otterwiki-2.2.0/.gitignore

@@ -0,0 +1,21 @@
+venv/
+env*
+build/
+*.pyc
+*.egg-info/
+dist/
+settings.cfg
+*.log*
+otterwiki/__pycache__
+repository
+*.sqlite
+.coverage
+coverage_html
+app-data*
+settings.cfg
+tmp
+docker-compose.override.yml
+.env
+.flaskenv
+.tox
+.idea

otterwiki-2.2.0/.mailmap

@@ -0,0 +1,2 @@
+Ralph Thesen <mail@redimp.de>	Ralph Thesen <ralph.thesen@scai.fraunhofer.de>
+Ralph Thesen <mail@redimp.de>	Ralph Thesen <thesen@ins.uni-bonn.de>

otterwiki-2.2.0/Dockerfile

@@ -0,0 +1,73 @@
+#
+# compile stage
+#
+FROM nginx:1.25.3 AS compile-stage
+LABEL maintainer="Ralph Thesen <mail@redimp.de>"
+# install python environment
+RUN \
+    apt-get update -y && \
+    apt-get upgrade -y && \
+    apt-get install -y python3.11 python3.11-venv python3-pip \
+    libjpeg-dev zlib1g-dev
+# prepare environment
+RUN python3 -m venv /opt/venv
+ENV PATH="/opt/venv/bin:$PATH"
+# upgrade pip and install requirements not in otterwiki
+RUN pip install -U pip wheel
+# copy app
+COPY . /app
+WORKDIR /app
+# install the otterwiki and its requirements
+RUN pip install .
+#
+# test stage
+#
+FROM compile-stage AS test-stage
+# install git (not needed for compiling)
+RUN apt-get update -y && apt-get install -y --no-install-recommends git
+# install the dev environment
+RUN pip install '.[dev]'
+# run tox (which builds a new environemnt and runs pytest)
+RUN tox
+# configure tox as default command when the test-stage is executed
+CMD ["tox"]
+#
+# production stage
+#
+FROM nginx:1.25.3
+# arg for marking dev images
+ARG GIT_TAG
+ENV GIT_TAG $GIT_TAG
+# environment variables (I'm not sure if anyone ever would modify this)
+ENV OTTERWIKI_SETTINGS=/app-data/settings.cfg
+ENV OTTERWIKI_REPOSITORY=/app-data/repository
+# install supervisord and python
+RUN DEBIAN_FRONTEND=noninteractive apt-get -y update && \
+  apt-get upgrade -y && \
+  apt-get install -y --no-install-recommends \
+  supervisor git \
+  python3.11 python3-wheel python3-venv libpython3.11 \
+  uwsgi uwsgi-plugin-python3 \
+  && rm -rf /var/lib/apt/lists/*
+# copy virtual environment
+COPY --from=compile-stage /opt/venv /opt/venv
+# Make sure we use the virtualenv:
+ENV PATH="/opt/venv/bin:$PATH"
+# create directories
+RUN mkdir -p /app-data /app/otterwiki
+VOLUME /app-data
+RUN chown -R www-data:www-data /app-data
+# copy static files for nginx
+COPY otterwiki/static /app/otterwiki/static
+# copy supervisord configs (nginx is configured in the entrypoint.sh)
+COPY docker/uwsgi.ini /app/uwsgi.ini
+COPY docker/supervisord.conf /etc/supervisor/conf.d/
+COPY --chmod=0755 docker/stop-supervisor.sh /etc/supervisor/
+# Copy the entrypoint that will generate Nginx additional configs
+COPY --chmod=0755 ./docker/entrypoint.sh /entrypoint.sh
+# configure the entrypoint
+ENTRYPOINT ["/entrypoint.sh"]
+# and the default command: supervisor which takes care of nginx and uWSGI
+CMD ["/usr/bin/supervisord"]
+
+# vim:set et ts=8 sts=2 sw=2 ai fenc=utf-8:

otterwiki-2.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ralph Thesen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

otterwiki-2.2.0/MANIFEST.in

@@ -0,0 +1,4 @@
+# include templates and static files in the package
+recursive-include otterwiki/templates *
+recursive-include otterwiki/static *
+include otterwiki/*.md

otterwiki-2.2.0/Makefile

@@ -0,0 +1,128 @@
+#
+#
+# Makefile for developing and building An Otter Wiki
+#
+# Please read the Installation guide <https://otterwiki.com/Installation>
+# to get started.
+#
+#
+PORT ?= 8080
+VERSION := $(shell python3 -c "with open('otterwiki/version.py') as f: exec(f.read());  print(__version__);")
+VERSION_MAJOR_MINOR := $(shell python3 -c "with open('otterwiki/version.py') as f: exec(f.read()); print('.'.join(__version__.split('.')[0:2]));")
+VERSION_MAJOR := $(shell python3 -c "with open('otterwiki/version.py') as f: exec(f.read()); print('.'.join(__version__.split('.')[0:1]));")
+PLATFORM ?= "linux/arm64,linux/amd64,linux/arm/v7,linux/arm/v6"
+
+all: run
+
+.PHONY: clean coverage run debug shell sdist docker-build docker-test
+
+clean:
+	rm -rf venv *.egg-info dist *.log* otterwiki/__pycache__ tests/__pycache__
+	rm -rf .pytest_cache .tox
+	rm -rf coverage_html
+
+venv: pyproject.toml
+	rm -rf venv
+	python3 -m venv venv
+	venv/bin/pip install -U pip wheel
+	venv/bin/pip install -e '.[dev]'
+
+run: venv settings.cfg
+	GIT_TAG=$(shell git describe --long) FLASK_APP=otterwiki.server OTTERWIKI_SETTINGS=$(PWD)/settings.cfg venv/bin/flask run --host 0.0.0.0 --port $(PORT)
+
+debug: venv settings.cfg
+	FLASK_ENV=development FLASK_DEBUG=True FLASK_APP=otterwiki.server OTTERWIKI_SETTINGS=../settings.cfg venv/bin/flask run --port $(PORT)
+
+profiler: venv settings.cfg
+	FLASK_DEBUG=True FLASK_APP=otterwiki.server OTTERWIKI_SETTINGS=../settings.cfg \
+        venv/bin/python otterwiki/profiler.py
+
+
+shell: venv
+	FLASK_DEBUG=True FLASK_APP=otterwiki.server OTTERWIKI_SETTINGS=../settings.cfg venv/bin/flask shell
+
+test: venv
+	OTTERWIKI_SETTINGS="" venv/bin/pytest tests
+
+tox: venv
+	venv/bin/tox
+
+venv/bin/coverage: venv
+	venv/bin/pip install coverage
+
+coverage: venv venv/bin/coverage
+	OTTERWIKI_SETTINGS="" venv/bin/coverage run --source=otterwiki -m pytest tests
+	venv/bin/coverage report
+	venv/bin/coverage html -d coverage_html
+
+black:
+	venv/bin/black setup.py otterwiki/ tests/
+
+sdist: venv test
+	venv/bin/python setup.py sdist
+
+settings.cfg:
+	@echo ""
+	@echo " Please create the settings.cfg. You find an example in the"
+	@echo " settings.cfg.skeleton"
+	@echo ""
+	@false
+
+tmp/codemirror-5.65.15:
+	mkdir -p tmp && \
+	cd tmp && \
+	test -f codemirror.zip || wget https://codemirror.net/5/codemirror.zip && \
+	unzip codemirror.zip
+
+otterwiki/static/js/cm-modes.min.js: tmp/codemirror-5.65.15
+	cat tmp/codemirror-5.65.15/addon/mode/simple.js > otterwiki/static/js/cm-modes.js
+	cat tmp/codemirror-5.65.15/mode/meta.js >> otterwiki/static/js/cm-modes.js
+	for MODE in shell clike xml python javascript markdown yaml php sql \
+		toml cmake perl http go rust dockerfile powershell properties \
+		stex nginx; do \
+		cat tmp/codemirror-5.65.15/mode/$$MODE/$$MODE.js \
+			>> otterwiki/static/js/cm-modes.js; \
+	done
+	./venv/bin/python -m rjsmin -p < otterwiki/static/js/cm-modes.js > otterwiki/static/js/cm-modes.min.js
+
+docker-test:
+	# make sure the image is rebuild
+	DOCKER_BUILDKIT=1 docker build --no-cache -t otterwiki:_test --target test-stage .
+
+docker-run:
+	DOCKER_BUILDKIT=1 docker build -t otterwiki:_build .
+	docker run -p 8080:80 otterwiki:_build
+
+docker-buildx-test:
+ifeq ($(strip $(shell git rev-parse --abbrev-ref HEAD)),main)
+	docker buildx build --no-cache --platform $(PLATFORM) --target test-stage .
+else
+	docker buildx build --no-cache --platform linux/arm64,linux/amd64 --target test-stage .
+endif
+
+docker-buildx-push: test
+# check if we are in the main branch (to avoid accidently pushing a feature branch
+ifeq ($(strip $(shell git rev-parse --abbrev-ref HEAD)),main)
+# check if git is clean
+ifneq ($(strip $(shell git status --porcelain)),)
+	$(error Error: Uncommitted changes in found)
+endif
+	docker buildx build --platform $(PLATFORM) \
+		-t redimp/otterwiki:latest \
+		-t redimp/otterwiki:$(VERSION) \
+		-t redimp/otterwiki:$(VERSION_MAJOR) \
+		-t redimp/otterwiki:$(VERSION_MAJOR_MINOR) \
+		--build-arg GIT_TAG="$(shell git describe --long)" \
+		--push .
+else
+	@echo ""
+	@echo "-- Building dev image"
+	@echo ""
+	docker buildx build --platform linux/arm64,linux/amd64 \
+		-t redimp/otterwiki:dev-$(shell git rev-parse --abbrev-ref HEAD) \
+		--build-arg GIT_TAG="$(shell git describe --long)_$(shell git rev-parse --abbrev-ref HEAD)" \
+		--push .
+	@echo ""
+	@echo "-- Done dev-image: redimp/otterwiki:dev-$(shell git rev-parse --abbrev-ref HEAD)"
+	@echo ""
+endif

otterwiki-2.2.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.1
+Name: otterwiki
+Version: 2.2.0
+Summary: An Otter Wiki is Python-based software for collaborative content management, called a wiki. The content is stored in a git repository, which keeps track of all changes. Markdown is used as markup language.
+Author-email: Ralph Thesen <mail@redimp.de>
+License: MIT License
+        
+        Copyright (c) 2022 Ralph Thesen
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: homepage, https://otterwiki.com
+Project-URL: repository, https://github.com/redimp/otterwiki
+Project-URL: issues, https://github.com/redimp/otterwiki/issues/
+Project-URL: Demo, https://demo.otterwiki.com
+Keywords: wiki,git,markdown
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: Wiki
+Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Werkzeug==3.0.1
+Requires-Dist: Flask-Login==0.6.3
+Requires-Dist: Flask-Mail==0.9.1
+Requires-Dist: SQLAlchemy==2.0.27
+Requires-Dist: Flask-SQLAlchemy==3.1.1
+Requires-Dist: Flask==3.0.2
+Requires-Dist: Jinja2==3.1.3
+Requires-Dist: gitpython==3.1.42
+Requires-Dist: cython==3.0.8
+Requires-Dist: mistune==2.0.5
+Requires-Dist: pygments==2.17.2
+Requires-Dist: Pillow==10.2.0
+Requires-Dist: unidiff==0.7.5
+Requires-Dist: flask-htmlmin==2.2.1
+Requires-Dist: beautifulsoup4==4.12.3
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: tox; extra == "dev"
+Requires-Dist: tbump; extra == "dev"
+Requires-Dist: rjsmin; extra == "dev"
+
+![](screenshot.png)
+
+# An Otter Wiki
+
+An Otter Wiki is Python-based software for collaborative content
+management, called a [wiki](https://en.wikipedia.org/wiki/Wiki). The
+content is stored in a git repository, which keeps track of all changes.
+[Markdown](https://daringfireball.net/projects/markdown) is used as
+Markup language. An Otter Wiki is written in [python](https://www.python.org/)
+using the microframework [Flask](http://flask.pocoo.org/).
+[halfmoon](https://www.gethalfmoon.com) is used as CSS framework
+and [CodeMirror](https://codemirror.net/) as editor.
+[Font Awesome Free](https://fontawesome.com/license/free) serves the icons.
+
+## Notable Features
+
+- Minimalistic interface (with dark-mode)
+- Editor with markdown highlighting and support including tables
+- Full changelog and page history
+- User authentication
+- Page Attachments
+- A very cute Otter as logo (drawn by [Christy Presler](http://christypresler.com/) CC BY 3.0).
+
+## Demo
+
+Check out the demo <https://demo.otterwiki.com>.
+
+## Installation
+
+Read the [installation guide](https://otterwiki.com/Installation) to get
+started. Recommended is the installation with `docker-compose`.
+
+### Quick start with docker-compose
+
+1. Copy and edit the `docker-compose.yml` below to match your preferences.
+2. Run `docker-compose up -d`
+3. Access the wiki via http://127.0.0.1:8080 if run on your machine.
+4. If the wiki shall be accessible via the internet and an domain name make sure to configure your web server accordingly. Check the [installation guide](https://otterwiki.com/Installation#reverse-proxy) for example configurations for nginx, apache and caddy.
+5. Register your account. The first account is an admin-account giving you access to the settings tab.
+6. Customize the settings to your liking.
+
+Proceed for the [configuration guide](https://otterwiki.com/Configuration) for
+detailed information.
+
+#### docker-compose.yml
+
+```yaml
+version: '3'
+services:
+  otterwiki:
+    image: redimp/otterwiki:2
+    restart: unless-stopped
+    ports:
+      - 8080:80
+    volumes:
+      - ./app-data:/app-data
+```
+
+## License
+
+An Otter Wiki is open-source software licensed under the [MIT License](https://github.com/redimp/otterwiki/blob/main/LICENSE).
+
+[modeline]: # ( vim: set fenc=utf-8 spell spl=en sts=4 et tw=72: )

otterwiki-2.2.0/README.md

@@ -0,0 +1,63 @@
+![](screenshot.png)
+
+# An Otter Wiki
+
+An Otter Wiki is Python-based software for collaborative content
+management, called a [wiki](https://en.wikipedia.org/wiki/Wiki). The
+content is stored in a git repository, which keeps track of all changes.
+[Markdown](https://daringfireball.net/projects/markdown) is used as
+Markup language. An Otter Wiki is written in [python](https://www.python.org/)
+using the microframework [Flask](http://flask.pocoo.org/).
+[halfmoon](https://www.gethalfmoon.com) is used as CSS framework
+and [CodeMirror](https://codemirror.net/) as editor.
+[Font Awesome Free](https://fontawesome.com/license/free) serves the icons.
+
+## Notable Features
+
+- Minimalistic interface (with dark-mode)
+- Editor with markdown highlighting and support including tables
+- Full changelog and page history
+- User authentication
+- Page Attachments
+- A very cute Otter as logo (drawn by [Christy Presler](http://christypresler.com/) CC BY 3.0).
+
+## Demo
+
+Check out the demo <https://demo.otterwiki.com>.
+
+## Installation
+
+Read the [installation guide](https://otterwiki.com/Installation) to get
+started. Recommended is the installation with `docker-compose`.
+
+### Quick start with docker-compose
+
+1. Copy and edit the `docker-compose.yml` below to match your preferences.
+2. Run `docker-compose up -d`
+3. Access the wiki via http://127.0.0.1:8080 if run on your machine.
+4. If the wiki shall be accessible via the internet and an domain name make sure to configure your web server accordingly. Check the [installation guide](https://otterwiki.com/Installation#reverse-proxy) for example configurations for nginx, apache and caddy.
+5. Register your account. The first account is an admin-account giving you access to the settings tab.
+6. Customize the settings to your liking.
+
+Proceed for the [configuration guide](https://otterwiki.com/Configuration) for
+detailed information.
+
+#### docker-compose.yml
+
+```yaml
+version: '3'
+services:
+  otterwiki:
+    image: redimp/otterwiki:2
+    restart: unless-stopped
+    ports:
+      - 8080:80
+    volumes:
+      - ./app-data:/app-data
+```
+
+## License
+
+An Otter Wiki is open-source software licensed under the [MIT License](https://github.com/redimp/otterwiki/blob/main/LICENSE).
+
+[modeline]: # ( vim: set fenc=utf-8 spell spl=en sts=4 et tw=72: )

otterwiki-2.2.0/docker/entrypoint.sh

@@ -0,0 +1,102 @@
+#!/usr/bin/env bash
+# vim:set et ts=8 sts=4 sw=4 ai fenc=utf-8:
+
+set -e
+
+# take care of repository dictionary
+if [ ! -d ${OTTERWIKI_REPOSITORY} ]; then
+    mkdir -p ${OTTERWIKI_REPOSITORY}
+fi
+
+if [ ! -d ${OTTERWIKI_REPOSITORY}/.git ]; then
+    git init ${OTTERWIKI_REPOSITORY}
+fi
+
+# take care of the otterwiki settings file
+if [ ! -f ${OTTERWIKI_SETTINGS} ]; then
+    RANDOM_SECRET_KEY=$(echo $RANDOM | md5sum | head -c 16)
+    echo "DEBUG = False" >> ${OTTERWIKI_SETTINGS}
+    echo "REPOSITORY = '/app-data/repository'" >> ${OTTERWIKI_SETTINGS}
+    echo "SECRET_KEY = '${RANDOM_SECRET_KEY}'" >> ${OTTERWIKI_SETTINGS}
+    echo "SQLALCHEMY_DATABASE_URI = 'sqlite:////app-data/db.sqlite'" >> ${OTTERWIKI_SETTINGS}
+fi
+
+# handle environment variables
+# branding
+for EV in SITE_NAME SITE_LOGO SITE_DESCRIPTION SITE_ICON; do
+    if [ ! -z "${!EV}" ]; then
+        sed -i "/^${EV}.*/d" ${OTTERWIKI_SETTINGS}
+        echo "${EV} = '${!EV}'" >> ${OTTERWIKI_SETTINGS}
+    fi
+done
+# permissions
+for EV in READ_ACCESS WRITE_ACCESS ATTACHMENT_ACCESS; do
+    if [ ! -z "${!EV}" ]; then
+        sed -i "/^${EV}.*/d" ${OTTERWIKI_SETTINGS}
+        echo "${EV} = '${!EV}'" >> ${OTTERWIKI_SETTINGS}
+    fi
+done
+for EV in AUTO_APPROVAL EMAIL_NEEDS_CONFIRMATION RETAIN_PAGE_NAME_CASE GIT_WEB_SERVER; do
+    if [ ! -z "${!EV}" ]; then
+        sed -i "/^${EV}.*/d" ${OTTERWIKI_SETTINGS}
+        echo "${EV} = ${!EV}" >> ${OTTERWIKI_SETTINGS}
+    fi
+done
+# mail
+for EV in MAIL_SERVER MAIL_USERNAME MAIL_PASSWORD MAIL_DEFAULT_SENDER; do
+    if [ ! -z "${!EV}" ]; then
+        sed -i "/^${EV}.*/d" ${OTTERWIKI_SETTINGS}
+        echo "${EV} = '${!EV}'" >> ${OTTERWIKI_SETTINGS}
+    fi
+done
+for EV in MAIL_PORT MAIL_USE_TLS MAIL_USE_SSL; do
+    if [ ! -z "${!EV}" ]; then
+        sed -i "/^${EV}.*/d" ${OTTERWIKI_SETTINGS}
+        echo "${EV} = ${!EV}" >> ${OTTERWIKI_SETTINGS}
+    fi
+done
+
+chown -R www-data:www-data /app-data
+
+# Get the maximum upload file size for Nginx, default to 0: unlimited
+USE_NGINX_MAX_UPLOAD=${NGINX_MAX_UPLOAD:-0}
+# Get the number of workers for Nginx, default to 1
+USE_NGINX_WORKER_PROCESSES=${NGINX_WORKER_PROCESSES:-1}
+# Modify the number of worker processes in Nginx config
+sed -i "/worker_processes\s/c\worker_processes ${USE_NGINX_WORKER_PROCESSES};" /etc/nginx/nginx.conf
+
+# Get the URL for static files from the environment variable
+USE_STATIC_URL=${STATIC_URL:-'/static'}
+# Get the absolute path of the static files from the environment variable
+USE_STATIC_PATH=${STATIC_PATH:-'/app/otterwiki/static'}
+# Get the listen port for Nginx, default to 80
+USE_LISTEN_PORT=${LISTEN_PORT:-80}
+
+# Generate Nginx config first part using the environment variables
+echo "server {
+    listen ${USE_LISTEN_PORT};
+    client_max_body_size $USE_NGINX_MAX_UPLOAD;
+" > /etc/nginx/conf.d/default.conf
+
+if [ ! -z "${REAL_IP_FROM}" ]; then
+echo "    set_real_ip_from $REAL_IP_FROM;
+    real_ip_header X-Real-IP;
+    real_ip_recursive on;" >> /etc/nginx/conf.d/nginx.conf
+fi
+
+
+echo "    location / {
+        try_files \$uri @app;
+    }
+    location @app {
+        include uwsgi_params;
+        uwsgi_pass unix:///tmp/uwsgi.sock;
+    }
+    location $USE_STATIC_URL {
+        alias $USE_STATIC_PATH;
+    }" >> /etc/nginx/conf.d/default.conf
+
+# close the server block
+echo "}" >> /etc/nginx/conf.d/default.conf
+
+exec "$@"

otterwiki-2.2.0/docker/stop-supervisor.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+# https://serverfault.com/a/922943
+printf "READY\n";
+
+while read line; do
+  echo "Processing Event: $line" >&2;
+  kill $PPID
+done < /dev/stdin

otterwiki-2.2.0/docker/supervisord.conf

@@ -0,0 +1,27 @@
+[supervisord]
+nodaemon=true
+user=root
+
+[program:uwsgi]
+command=/usr/bin/uwsgi_python3 --ini /app/uwsgi.ini --venv /opt/venv
+stdout_logfile=/dev/stdout
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/stderr
+stderr_logfile_maxbytes=0
+startsecs=0
+autorestart=false
+
+[program:nginx]
+command=/usr/sbin/nginx -g 'daemon off;'
+stdout_logfile=/dev/stdout
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/stderr
+stderr_logfile_maxbytes=0
+# Graceful stop would be QUIT, see http://nginx.org/en/docs/control.html
+stopsignal=TERM
+startsecs=0
+autorestart=false
+
+[eventlistener:quit_on_failure]
+events=PROCESS_STATE_STOPPED,PROCESS_STATE_EXITED,PROCESS_STATE_FATAL
+command=/etc/supervisor/stop-supervisor.sh

otterwiki-2.2.0/docker/uwsgi.ini

@@ -0,0 +1,36 @@
+[uwsgi]
+module = otterwiki.server
+callable = app
+# socket configuration
+socket = /tmp/uwsgi.sock
+pidfile = /tmp/uwsgi.pid
+chdir = /app
+chown-socket = nginx:nginx
+chmod-socket = 664
+# Graceful shutdown on SIGTERM, see https://github.com/unbit/uwsgi/issues/849#issuecomment-118869386
+hook-master-start = unix_signal:15 gracefully_kill_them_all
+need-app = true
+die-on-term = true
+# we run a single app
+single-interpreter = true
+# For debugging and testing
+show-config = true
+vacuum = true
+# fixing WARNING: you are running uWSGI without its master process manager
+master = true
+uid = www-data
+gid = www-data
+# wsgi.file_wrapper is an optimization of the WSGI standard. In some
+# corner case it can raise an error. For example when returning an
+# in-memory bytes buffer (io.Bytesio) in Python 3.5.
+# see https://uwsgi-docs.readthedocs.io/en/latest/ThingsToKnow.html
+wsgi-disable-file-wrapper = true
+# enable threads, which are disabled by default
+# see https://uwsgi-docs.readthedocs.io/en/latest/WSGIquickstart.html#a-note-on-python-threads
+enable-threads = true
+# disable logs
+disable-logging = true
+# close the uwsgi processes quicker, when hitting Ctrl-C
+reload-mercy = 5
+worker-reload-mercy = 5
+env=HOME=/app-data