[Pkg-javascript-commits] [rainloop] 02/02: Added documentation and sample webserver configuration files.

[Daniel Ring]

This is an automated email from the git hooks/post-receive script.

techwolf-guest pushed a commit to branch master
in repository rainloop.

commit 41462354acf80aeddb0fe320a9f3295605d6ebdc
Author: Daniel Ring <dring at wolfishly.me>
Date:   Wed Mar 21 17:17:43 2018 -0700

    Added documentation and sample webserver configuration files.
---
 debian/README.Debian             | 61 ++++++++++++++++++++++++++++++++++++++++
 debian/conf/rainloop.apache.conf | 16 +++++++++++
 debian/conf/rainloop.nginx.conf  | 44 +++++++++++++++++++++++++++++
 debian/control                   |  1 +
 debian/rainloop.docs             |  3 ++
 5 files changed, 125 insertions(+)

diff --git a/debian/README.Debian b/debian/README.Debian
new file mode 100644
index 0000000..bd2e37e
--- /dev/null
+++ b/debian/README.Debian
@@ -0,0 +1,61 @@
+
+RainLoop Webmail for Debian
+===========================
+
+Table of Contents:
+1. Nginx Configuration
+2. Apache2 Configuration
+3. Use with Other Webservers
+4. Configuring RainLoop
+5. Upstream Support
+
+
+Nginx Configuration
+-------------------
+The Debian package for RainLoop provides a sample nginx config file in
+`/usr/share/doc/rainloop/rainloop.nginx.conf`. To use it, copy the file to
+`/etc/nginx/sites-available/` and apply any desired modifications. To
+publish the site, add a symlink to the file in `/etc/nginx/sites-enabled/`
+and reload the nginx service.
+
+
+Apache2 Configuration
+--------------------
+The Debian package for RainLoop provides a sample Apache2 config file in
+`/usr/share/doc/rainloop/rainloop.apache.conf`. To use it, copy the file to
+`/etc/apache2/sites-available/` and apply any desired modifications. To
+publish the site, add a symlink to the file in `/etc/apache2/sites-enabled/`
+and reload the apache2 service.
+
+
+Use with Other Webservers
+-------------------------
+To use RainLoop with other web servers, either set the website root to
+`/usr/share/rainloop/` or place a symlink to it in a web-accessible directory.
+The web server must support PHP in order to run RainLoop.
+
+
+Configuring RainLoop
+--------------------
+RainLoop's main config file `/etc/rainloop/application.ini`, and can be
+modified by hand or by a configuration management tool. Configurations for
+individual email domains are located in `/etc/rainloop/domains`; a sample for
+connecting to a local IMAP server is provided in
+`/etc/rainloop/domains/localhost.ini`.
+
+RainLoop provides a web UI for configuration management as well, but it is
+disabled by default in Debian. To enable it, set "allow_admin_panel" to "On"
+in `/etc/rainloop/application.ini`. The default administrator username is
+"admin" with the password "12345"; please change the password before exposing
+the web-based admin panel to the internet. Setting a new password from within
+the admin panel will store the password as a hash instead of plaintext.
+
+
+Upstream Support
+----------------
+The official website for RainLoop is https://www.rainloop.net/. For issues
+with the software, please contact upstream support at "support at rainloop.net"
+or file an issue on GitHub at https://github.com/RainLoop/rainloop-webmail/.
+
+For issues with the Debian packaging of the software, follow the standard
+Debian bug reporting process.
diff --git a/debian/conf/rainloop.apache.conf b/debian/conf/rainloop.apache.conf
new file mode 100644
index 0000000..037f1a6
--- /dev/null
+++ b/debian/conf/rainloop.apache.conf
@@ -0,0 +1,16 @@
+## RainLoop default configuration for Apache2
+
+<VirtualHost *:80>
+	# For use as a virtual host, set ServerName to the desired FQDN.
+	#ServerName www.example.com
+	DocumentRoot /usr/share/rainloop
+
+	# SSL configuration
+	#SSLEngine on
+	#SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem
+	#SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
+
+	# Log configuration
+	ErrorLog ${APACHE_LOG_DIR}/error.log
+	CustomLog ${APACHE_LOG_DIR}/access.log combined
+</VirtualHost>
diff --git a/debian/conf/rainloop.nginx.conf b/debian/conf/rainloop.nginx.conf
new file mode 100644
index 0000000..56838d8
--- /dev/null
+++ b/debian/conf/rainloop.nginx.conf
@@ -0,0 +1,44 @@
+## Rainloop default configuration for Nginx
+
+server {
+	# Listen as the default server when no virtual host is specified.
+	listen 80 default_server;
+	listen [::]:80 default_server;
+
+	# SSL configuration
+	#listen 443 ssl default_server;
+	#listen [::]:443 ssl default_server;
+	#ssl on;
+	#ssl_certificate /etc/ssl/certs/ssl-cert-snakeoil.pem;
+	#ssl_certificate_key /etc/ssl/private/ssl-cert-snakeoil.key;
+
+	# For use as a virtual host, set server_name to the desired FQDN.
+	server_name _;
+	root /usr/share/rainloop;
+	index index.php index.html;
+
+	# Log configuration
+	access_log /var/log/nginx/rainloop.access.log;
+	error_log /var/log/nginx/rainloop.error.log warn;
+
+	location / {
+		# PHP-FPM configuration
+		location ~[^/]\.php(/|$) {
+			fastcgi_split_path_info ^(.+?\.php)(/.*)$;
+			if (!-f $document_root$fastcgi_script_name) {
+				return 404;
+			}
+
+			# For use with a different version of PHP, update the
+			# path in fastcgi_pass to the location of the current
+			# PHP-FPM socket.
+			fastcgi_pass unix:/run/php/php7.2-fpm.sock;
+			fastcgi_index index.php;
+			include fastcgi.conf;
+		}
+
+		# First attempt to serve request as file, then
+		# as directory, then fall back to displaying a 404.
+		try_files $uri $uri/ index.php index.html;
+	}
+}
diff --git a/debian/control b/debian/control
index 7e0cb43..a21d86e 100644
--- a/debian/control
+++ b/debian/control
@@ -46,6 +46,7 @@ Vcs-Browser: https://anonscm.debian.org/cgit/pkg-javascript/rainloop.git
 Package: rainloop
 Architecture: all
 Depends: ${misc:Depends},
+ nginx | apache2 | httpd,
  php-fpm (>= 5.4) | libapache2-mod-php (>= 5.4),
  php-curl,
  php-json,
diff --git a/debian/rainloop.docs b/debian/rainloop.docs
index c8c2e5b..95ffafe 100644
--- a/debian/rainloop.docs
+++ b/debian/rainloop.docs
@@ -1,3 +1,6 @@
 CODE_OF_CONDUCT.md
 CONTRIBUTING.md
 README.md
+debian/README.Debian
+debian/conf/rainloop.nginx.conf
+debian/conf/rainloop.apache.conf

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/rainloop.git