Merge pull request #77 from drizzit56/main

Added an nginx config for cerebrate

INSTALL/INSTALL.md

@@ -1,8 +1,9 @@
 ## Requirements
 
 An Ubuntu server (18.04/20.04 should both work fine) - though other linux installations should work too.
-- apache2, mysql/mariadb, sqlite need to be installed and running
+- apache2 (or nginx), mysql/mariadb, sqlite need to be installed and running
 - php extensions for intl, mysql, sqlite3, mbstring, xml need to be installed and running
+- php extention for curl (not required but makes composer run a little faster)
 - composer
 
 ## Network requirements
@@ -17,8 +18,16 @@ Cerebrate communicates via HTTPS so in order to be able to connect to other cere
 ## Cerebrate installation instructions
 
 It should be sufficient to issue the following command to install the dependencies:
+
+- for apache
+
 ```bash
-sudo apt install apache2 mariadb-server git composer php-intl php-mbstring php-dom php-xml unzip php-ldap php-sqlite3 sqlite libapache2-mod-php php-mysql
+sudo apt install apache2 mariadb-server git composer php-intl php-mbstring php-dom php-xml unzip php-ldap php-sqlite3 php-curl sqlite libapache2-mod-php php-mysql
+```
+
+- for nginx
+```bash
+sudo apt install nginx mariadb-server git composer php-intl php-mbstring php-dom php-xml unzip php-ldap php-sqlite3 sqlite php-fpm php-curl php-mysql
 ```
 
 Clone this repository (for example into /var/www/cerebrate)
@@ -79,7 +88,7 @@ sudo -u www-data cp -a /var/www/cerebrate/config/config.example.json /var/www/ce
 sudo -u www-data vim /var/www/cerebrate/config/app_local.php
 ```
 
-mod_rewrite needs to be enabled:
+mod_rewrite needs to be enabled if __using apache__:
 
 ```bash
 sudo a2enmod rewrite
@@ -112,16 +121,31 @@ sudo rm /var/www/cerebrate/tmp/cache/persistent/*
 
 Create an apache config file for cerebrate / ssh key and point the document root to /var/www/cerebrate/webroot and you're good to go
 
-For development installs the following can be done:
+For development installs the following can be done for either apache or nginx:
 
 ```bash
+# Apache
 # This configuration is purely meant for local installations for development / testing
 # Using HTTP on an unhardened apache is by no means meant to be used in any production environment
-sudo cp /var/www/cerebrate/INSTALL/cerebrate_dev.conf /etc/apache2/sites-available/
-sudo ln -s /etc/apache2/sites-available/cerebrate_dev.conf /etc/apache2/sites-enabled/
+sudo cp /var/www/cerebrate/INSTALL/cerebrate_apache_dev.conf /etc/apache2/sites-available/
+sudo ln -s /etc/apache2/sites-available/cerebrate_apache_dev.conf /etc/apache2/sites-enabled/
 sudo service apache2 restart
 ```
 
+OR
+
+```bash
+# NGINX
+# This configuration is purely meant for local installations for development / testing
+# Using HTTP on an unhardened apache is by no means meant to be used in any production environment
+sudo cp /var/www/cerebrate/INSTALL/cerebrate_nginx.conf /etc/nginx/sites-available/
+sudo ln -s /etc/nginx/sites-available/cerebrate_nginx.conf /etc/nginx/sites-enabled/
+sudo systemctl disable apache2 # may be required if apache is using port
+sudo service nginx restart
+sudo systemctl enable nginx
+
+```
+
 Now you can point your browser to: http://localhost:8000
 
 To log in use the default credentials below:

INSTALL/cerebrate_nginx.conf

@@ -0,0 +1,37 @@
+## Cerebrate Nginx Web Server Configuration
+server {
+        listen 8000;
+        # listen 443 ssl;
+
+        root /var/www/cerebrate/webroot;
+        error_log /var/log/nginx/cerebrate_error.log;
+        access_log /var/log/nginx/cerebrate_access.log;
+
+        # Add index.php to the list if you are using PHP
+        index index.html index.htm index.nginx-debian.html index.php;
+
+        server_name _;
+
+        # Configure Crypto Keys/Certificates/DH
+        # If enabling this setting change port above, should also set the server name
+        # ssl_certificate         /path/to/ssl/cert;
+        # ssl_certificate_key     /path/to/ssl/cert;
+
+        # enable HSTS
+        # add_header Strict-Transport-Security "max-age=15768000; includeSubdomains";
+        # add_header X-Frame-Options SAMEORIGIN;
+
+        location / {
+                try_files $uri $uri/ /index.php?$args;
+        }
+
+       location ~ \.php$ {
+               try_files $uri =404;
+               fastcgi_split_path_info ^(.+\.php)(/.+)$;
+               fastcgi_pass            unix:/var/run/php/php7.4-fpm.sock;
+               fastcgi_index           index.php;
+               include                 fastcgi_params;
+               fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+               fastcgi_param PATH_INFO $fastcgi_path_info;
+       }
+}