Installation on Raspbian Stretch or Buster

Note

This is a standalone, distribution-specific version of INSTALL.md. You do not need to read or follow the original file, but can refer to it for generic steps like setting up SSH keys (which are assumed to be common knowledge here)

piku setup is simplified in modern Debian versions, since it can take advantage of some packaging improvements in uWSGI and does not require a custom systemd service. However, Stretch still ships with Python 3.5, which means it's not an ideal environment for new deployments on both Intel and ARM devices (Buster, in turn, ships with Python 3.7).

Setting up your Raspberry Pi

Download and install Raspbian onto an SD card.

After you install it is recommended that you do the following to update your installation to the latest available software.

# update apt-get
sudo apt-get update

# upgrade all software
sudo apt-get upgrade

Configure your installation. It is recommended that Change Password from the default and setup Locale Options (Locale and Timezone) and EXPAND FILESYSTEM. You will also want to Enable SSH.

# configure your installation
sudo raspi-config

At this point it is a good idea to sudo shutdown -h now and make a backup image of the card.

Dependencies

Before installing piku, you need to install the following packages:

sudo apt-get install -y build-essential certbot git \
    libjpeg-dev libxml2-dev libxslt1-dev zlib1g-dev nginx \
    python-certbot-nginx python-dev python-pip python-virtualenv \
    python3-dev python3-pip python3-click python3-virtualenv \
    uwsgi uwsgi-plugin-asyncio-python3 uwsgi-plugin-gevent-python \
    uwsgi-plugin-python uwsgi-plugin-python3 uwsgi-plugin-tornado-python \
    uwsgi-plugin-lua5.1 uwsgi-plugin-lua5.2 uwsgi-plugin-luajit

Set up the piku user, Set up SSH access

See INSTALL.md

uWSGI Configuration

uWSGI in Stretch and Buster requires very little configuration, since it is already properly packaged. All you need to do is create a symlink to the piku configuration file in /etc/uwsgi/apps-enabled:

sudo ln /home/$PAAS_USERNAME/.piku/uwsgi/uwsgi.ini /etc/uwsgi/apps-enabled/piku.ini
sudo systemctl restart uwsgi

nginx Configuration

piku requires you to edit /etc/nginx/sites-available/default to the following, so it can inject new site configurations into nginx:

server {
    listen 80 default_server;
    listen [::]:80 default_server;
    root /var/www/html;
    index index.html index.htm;
    server_name _;
    location / {
        try_files $uri $uri/ =404;
    }
}
# replace `PAAS_USERNAME` with the username you created.
include /home/PAAS_USERNAME/.piku/nginx/*.conf;

Set up systemd.path to reload nginx upon config changes

# Set up systemd.path to reload nginx upon config changes
sudo cp ./piku-nginx.{path, service} /etc/systemd/system/
sudo systemctl enable piku-nginx.{path,service}
sudo systemctl start piku-nginx.path
# Check the status of piku-nginx.service
systemctl status piku-nginx.path # should return `Active: active (waiting)`
# Restart NGINX
sudo systemctl restart nginx

Notes

This file was last updated on June 2019