Installation

All operations below should be performed as root.

Install Canopy Portal

Ensure you are installing one of the supported versions available from https://clients.checksec.com. The below filenames are for illustration purposes only.

Installing on Ubuntu

apt install -f ./canopyportal_1.1.0~18.04_amd64.deb

Installing on RHEL/OEL/CentOS 7

yum install -y ./canopyportal-0.0.2.el7.x86_64.rpm

Initialize the DB

canopyportal-manage setupdb --prod

Create the first user (Use an email address for username)

canopyportal-manage createsuperuser

Setup a webserver to act as reverse proxy

canopyportal-setup nginx

Restart the service

systemctl restart canopyportal

Confirm restart was successful by viewing logs

journalctl -u canopyportal

Logging configuration

Canopy Portal uses systemd for logging but by default most Linux distributions do not persist systemd logs. The following commands will configure systemd/journald to persist its logs to disk:

mkdir /var/log/journal
systemctl restart systemd-journald

If systemd is not configured to persist logs then they will not survive reboots.

Additionally one should adjust the default rate limit for logging as there might be times when Canopy Portal emits large bursts of logs.

In /etc/systemd/journald.conf, set the following:

RateLimitBurst=0  # Disable rate limiting

and reload journald:

systemctl restart systemd-journald

Please see man journald.conf or https://www.freedesktop.org/software/systemd/man/journald.conf.html for more information on how to configure logging.