added init scripts and services and fixed small issues

Author: bb-Ricardo

README.md

@@ -15,6 +15,7 @@ by [Harrier Central](https://www.harriercentral.com)
 * pytz
 * phpserialize
 * mysql-connector
+* psutil
 
 ### WP Event Manager Plugin
 * WP Event Manager >= 3.1.21
@@ -24,19 +25,19 @@ by [Harrier Central](https://www.harriercentral.com)
 
 ## RedHat based OS
 * on RedHat/CentOS 7 you need to install python3.6 and pip from EPEL first
-* on RedHat/CentOS 8 systems the package name changed to `python3-pip`
-```
+* on RHEL/Rocky Linux 8 systems the package name changed to `python3-pip`
+```shell
 yum install python36-pip
 ```
 
 ## Ubuntu 18.04 & 20.04
-```
+```shell
 apt-get update && apt-get install python3-venv
 ```
 
 ## Clone repo and install dependencies
 * download and setup of virtual environment
-```
+```shell
 cd /opt
 git clone https://github.com/bb-Ricardo/wordpress-hash-event-api.git
 cd wordpress-hash-event-api
@@ -45,6 +46,50 @@ python3 -m venv .venv
 pip3 install -r requirements.txt || pip install -r requirements.txt
 ```
 
+## Install as systemd service
+If files have been installed in a different directory then the systemd service file
+needs to be edited.
+
+Ubuntu
+```shell
+cp /opt/wordpress-hash-event-api/contrib/wordpress-hash-event-api.service /etc/systemd/system
+```
+RHEL/Rocky Linux
+```shell
+sed -e 's/nogroup/nobody/g' /opt/wordpress-hash-event-api/contrib/wordpress-hash-event-api.service > /etc/systemd/system/wordpress-hash-event-api.service
+```
+
+Enable and start service
+```shell
+systemctl daemon-reload
+systemctl start wordpress-hash-event-api
+systemctl enable wordpress-hash-event-api
+```
+
+## Install as OpenRC service
+The [uvicorn.confd](contrib/uvicorn.confd) config file needs to be copied to `/etc/conf.d/`.
+Let's assume the API is called `nerd-h3`.
+```shell
+cp contrib/uvicorn.confd /etc/conf.d/uvicorn.nerd-h3
+chmod 644 /etc/conf.d/uvicorn.nerd-h3
+```
+
+The init script [uvicorn.openrc](contrib/uvicorn.openrc) needs to be copied to `etc/init.d/`
+and symlinked.
+```shell
+cp contrib/uvicorn.openrc /etc/init.d/uvicorn
+chmod 755 /etc/init.d/uvicorn
+cd /etc/init.d
+ln -s uvicorn uvicorn.nerd-h3
+```
+
+Then the correct values need to be set in `/etc/conf.d/uvicorn.nerd-h3`. After the configuration
+is finished the service can be started.
+```shell
+/etc/init.d/uvicorn.nerd-h3 start
+rc-update add uvicorn.nerd-h3 default
+```
+
 ## Docker
 
 Run the application in docker container
@@ -74,7 +119,7 @@ All options are described in the example file.
 - [x] add docker file
 - [x] try to add "auto-install", this should set up the WordPress Event Manager to add all available fields to all events
 - [x] requirements.ini
-- [ ] add OpenRC init script and config to server API via uvicorn
+- [x] add OpenRC init script and config to server API via uvicorn
 - [ ] add nginx config example
   - [ ] add CORS Headers to nginx config
 

common/log.py

@@ -8,6 +8,8 @@
 #  repository or visit: <https://opensource.org/licenses/MIT>.
 
 import logging
+import psutil
+import os
 
 # define valid log levels
 valid_log_levels = ["DEBUG", "INFO", "WARNING", "ERROR"]
@@ -41,6 +43,13 @@ def setup_logging(log_level=None):
 
     log_format = '%(asctime)s - %(levelname)s: %(message)s'
 
+    # if app is started via systemd then strip time stamp from log format
+    try:
+        if psutil.Process(psutil.Process(os.getpid()).ppid()).name() == "systemd":
+            log_format = '%(levelname)s: %(message)s'
+    except Exception as e:
+        print(f"unable to determine parent process name: {e}")
+
     if log_level is None or log_level == "":
         print("ERROR: log level undefined or empty. Check config please.")
         exit(1)

contrib/uvicorn.confd

@@ -0,0 +1,50 @@
+# /etc/conf.d/uvicorn
+# vim: set ft=sh:
+
+###############################################################################
+#    This configuration file defines default options for all uvicorn apis     #
+#                      managed by uvicorn.* runscripts.                       #
+#                                                                             #
+#       Specific configuration for each API should be defined in a file       #
+#                       /etc/conf.d/uvicorn.<API_NAME>.                        #
+###############################################################################
+
+#
+# This is an example configuration for uvicorn runscript. It contain all
+# user-definable variables with their default values. If the default value is
+# suitable for you, then you can omit that variable in your API config.
+#
+
+
+# User to run the uvicorn process.
+#user="nobody"
+
+# Group to run the uvicorn process.
+#group="nobody"
+
+# Where to store the uvicorn process PID.
+#pidfile="/run/uvicorn/${API_NAME}/uvicorn.pid"
+
+# Where to redirect stdout/stderr of the uvicorn process.
+#logfile="/var/log/uvicorn/${API_NAME}.log"
+
+# Is this instance a "development" or a "production" environment
+# will add "--reload" to uvicorn command line if set to "development"
+#environment=production
+
+# The path where this uvicorn api is installed
+#app_path="/var/www/my-api-app"
+
+# The desired app which should be served by uvicorn
+#app_call="main:app"
+
+# The port this uvicorn instance will listen on
+#port="8000"
+
+# Any additional arguments to be passed to uvicorn command.
+# More options here: https://www.uvicorn.org/settings/
+#extra_args=""
+
+# Specify service dependencies. You can use the same directives as in the
+# depend() function, but as variables prefixed by "rc_" (e.g. rc_need, rc_use).
+#rc_need=""

contrib/uvicorn.openrc

@@ -0,0 +1,75 @@
+#!/sbin/openrc-run
+# vim: set ft=sh: ts=4:
+
+API_NAME="${RC_SVCNAME#uvicorn.}"
+
+: ${user:=nobody}
+: ${group:=nobody}
+: ${pidfile:=/run/uvicorn/${API_NAME}/uvicorn.pid}
+: ${logfile:=/var/log/uvicorn/${API_NAME}.log}
+
+: ${environment:=production}
+: ${app_path:=/var/www/my-api-app}
+: ${app_call:=main:app}
+: ${port:=8000}
+: ${extra_args:=}
+
+name="API $API_NAME"
+description="uvicorn FastAPI \"$API_NAME\""
+
+# using find in app_path to find uvicorn bin
+command=""
+
+command_args="${app_call} --app-dir '${app_path}' --port ${port}"
+command_background='yes'
+command_user="$user"
+command_group="$group"
+
+start_stop_daemon_args="--wait=1000 --stdout=$logfile --stderr=$logfile"
+
+depend() {
+	need net
+}
+
+start_pre() {
+	if [ "$RC_SVCNAME" = 'uvicorn' ]; then
+		eerror ''
+		eerror 'You are not supposed to run this runscript directly. Instead, you should'
+		eerror 'create a symlink for the API you want to run as well as a copy of the'
+		eerror 'configuration file and modify it appropriately, like so:'
+		eerror ''
+		eerror '    ln -s uvicorn /etc/init.d/uvicorn.example'
+		eerror '    cp /etc/conf.d/uvicorn /etc/conf.d/uvicorn.example'
+		return 1
+	fi
+
+  command=$(find "${app_path}" -type f -name "uvicorn" 2>/dev/null)
+
+  if [ -z "$command" ]; then
+    eerror ''
+    eerror 'command "uvicorn" not found in app_path "'${app_path}'"'
+    return 1
+  fi
+
+	if [ ! "$environment" = "production"  ]; then
+		command_args="$command_args --reload --reload-dir '${app_path}'"
+	fi
+
+  command_args="$command_args $extra_args"
+
+	local path; for path in "$pidfile" "$logfile"; do
+		# checkpath doesn't create intermediate directories
+		file_dir_path="$(dirname "$path")"
+		mkdir -p "$file_dir_path"
+		[ ! "$file_dir_path" = "/var/log" ] && checkpath -d -m 0755 -o root:root "$file_dir_path"
+		touch "$path"
+		[ ! "$path" = "$pidfile" ] && checkpath -f -m 0640 -o $user:$group "$path"
+	done
+
+	return 0
+}
+
+stop_post() {
+	[ -f "$pidfile" ] && rm -f "$pidfile"
+	return 0
+}

contrib/wordpress-hash-event-api.service

@@ -0,0 +1,20 @@
+[Unit]
+Description=WordpPress Hash Event API
+Wants=network-online.target
+After=network-online.target
+
+[Service]
+Type=simple
+User=nobody
+Group=nogroup
+WorkingDirectory=/opt/wordpress-hash-event-api
+ExecStart=/opt/wordpress-hash-event-api/.venv/bin/uvicorn main:app --port 8001 --proxy-headers
+StandardOutput=syslog
+StandardError=syslog
+SyslogIdentifier=wordpress-hash-event-api
+RemainAfterExit=no
+Restart=always
+RestartSec=5s
+
+[Install]
+WantedBy=multi-user.target

main.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python3.9
+#!/usr/bin/env python3
 #  Copyright (c) 2021 Ricardo Bartels. All rights reserved.
 #
 #  wordpress-hash-event-api

requirements.txt

@@ -1,7 +1,9 @@
-starlette
-fastapi
-pydantic
-uvicorn
-pytz
-phpserialize
-mysql-connector
+wheel
+starlette==0.17.1
+fastapi==0.71.0
+pydantic==1.9.0
+uvicorn==0.17.0
+pytz==2021.3
+phpserialize==1.3
+mysql-connector==2.2.9
+psutil==5.9.0