| Table of Contents | ||
|---|---|---|
|
Supported Platforms
Canopy is officially supported on the following operating systems:
| Operating System | Version | Notes |
|---|---|---|
| Ubuntu Linux | 16.04 LTS |
| Server edition | |
| Ubuntu Linux | 14.04 LTS |
| Server edition |
| (Note: Canopy 3.1+ requests 16.04+). | |
| RedHat Enterprise Linux | v7 |
| N/A | |
| CentOS Linux | v7 |
| N/A | |
| Oracle Enterprise Linux | v7 |
| N/A |
| Info |
|---|
Canopy can run on other operating systems/distributions, such as Debian, Kali Linux and Mac OSX. However, Canopy will only be supported on the above operating systems |
...
| Key Dependency | Description |
|---|---|
| Django | Web application framework for powering Canopy |
| PostgreSQL or Oracle | DB server for storing/processing Canopy related data. Note that certain DB servers may require more resources. |
| nginx | Front end web server for serving the Canopy user interface |
| RabbitMQ Server | Backend service for processing Canopy related tasks using the Celery framework |
| Celery | Celery, a distributed task queue. |
| OpenJDK 8 or Oracle Java 8 | Java 8 runtime library for document generation. |
| Info |
|---|
The above dependencies are installed automatically by the canopy and canopy docserver packages - with the exception of some pre-configuration requirements for Oracle Java - under normal circumstances. In managed environments, access to dependencies may be restricted by corporate security policy. Contact support@checksec.com for assistance. |
Platform installation guides
Install on Ubuntu 16.04
...
As root:
apt install openjdk-8-jre(Alternatively install Oracle Java 8 if it is available)(On Ubuntu 16.04) software-properties-common && add-apt-repository -y ppa:webupd8team/java && apt updateapt install -f ./libtidy5_5.2.0-2_amd64.debapt install -f ./canopy_3.0.7_amd64.deb ./canopy-docserver_0.0.13_amd64.deb- Setup a Database via steps in the Configuration section below.
service supervisor restart
...
| Code Block |
|---|
$ supervisorctl restart canopy canopy-celery docserver |
Install on Ubuntu 14.04
The process for Ubuntu 14.04 is similar to 16.04 but one cannot use the apt command to install deb files directly. Instead one should use gdebi.
As root:
apt install software-properties-common gdebi-core && add-apt-repository -y ppa:webupd8team/java && apt updatefor DEB in *tidy*.deb canopy*.deb; do gdebi -n $DEB;done- Setup a Database via steps in the Configuration section below.
service supervisor restart
Confirm the supervisor service is running via:
| Code Block |
|---|
$ supervisorctl status |
if it is not running or if you would like to restart it:
| Code Block |
|---|
$ supervisorctl restart canopy canopy-celery docserver |
Install on CentOS 7, RHEL 7 and Oracle EL 7
As root(Centos):
yum install epel-release wgetFrom http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html get the URL for the current JRE *Check the "Accept License Agreement"- Download Oracle Java 8 JRE
wget --no-cookies --no-check-certificate --header "Cookie: oraclelicense=accept-securebackup-cookie" 'http://download.oracle.com/otn-pub/java/jdk/8u144-b01/090f390dda5b47b9b721c7dfaa008135/jre-8u144-linux-x64.rpm' - Install Oracle Java 8
yum localinstall jre-8u121-linux-x64.rpm - Install libtidy5
yum install ./libtidy5-5.2.0-2.3.x86_64.rpm - Install Canopy
yum install ./canopy-3.0.7-1.el7.centos.x86_64.rpmIf the installation fails with conflicting files(/opt/checksec/canopy/lib/...) then remove those directories and try again.
- Install Canopy docserver
yum install ./canopy-docserver-0.0.7-1.el7.centos.x86_64.rpm - Setup a Database via steps in the Configuration section below.
service supervisor restart
...
In order to install canopy follow the above steps for the operating system you are using. Howvever, you can ignore the steps involving the installation/configuration of Oracle Java 8 and the installation of the canopy-docserver package.
Then proceed to the Configuration steps below.
Install canopy docserver (documet server)
In order to install the canopy document server, follow the above steps for installing Oracle Java 8 on your chosen operating system. Once those steps are complete, proceed to install the canopy-docserver package. For example, on Ubuntu 16.04 LTS (as root):
...