diff options
author | Roland Stigge <stigge@antcom.de> | 2018-01-08 16:57:47 +0100 |
---|---|---|
committer | Roland Stigge <stigge@antcom.de> | 2018-01-08 16:57:47 +0100 |
commit | d8eae5827b2599bb1fb125aed47d73bf82d1ff10 (patch) | |
tree | 97c835f8580e4eb102185b2a7cbbe9c2e559db5f /debian/README.Debian | |
parent | 34f772d353839b5febcc0cad2a54e29716dcb6c8 (diff) |
Debian package, fix list xml
Diffstat (limited to 'debian/README.Debian')
-rw-r--r-- | debian/README.Debian | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/debian/README.Debian b/debian/README.Debian new file mode 100644 index 0000000..65db4e4 --- /dev/null +++ b/debian/README.Debian @@ -0,0 +1,100 @@ +webbox for Debian +================= + +This package is implemented as a FastCGI application in Apache. + +After installing this package and its dependencies, the following +directories are relevant: + +* Webbox FCGI Application directory: /usr/lib/webbox + +* Webbox HTML directory: /var/www/webbox + + This directory is part of the webbox package and contains all static + contents to be served by apache as web UI interface of webbox. + + In an Apache configuration, this directory is specified as + DocumentRoot or Alias. + +* Webbox directory(s): e.g. /home/webbox + + This directory or directories contain the actual contents to be served. + It can be specified multiple times in an Apache configuration to + implement several webboxes in one server. + + The contained files need to be owned by the www-data user. + + This directory is specified via the WEBBOX_PATH environment variable. + + +File browser +------------ + +The file browser can be used via the URL + +http://<servername>/<path> + +where servername is the host name served as VirtualHost by Apache +and <path> is the Alias configured in the Apache configuration for +the actual files (or DocumentRoot if no <path> component is +required). + +All files readable by the user www-data are served, except for +hidden files (i.e. beginning with a "."). + + +Environment Variables +--------------------- + +The following environment variables are supported: + +WEBBOX_PATH + + Directory with the payload files to be served by a webbox. + +WEBBOX_NAME + + Title of the webbox. Will be written on top of the Web UI. + + +Example configuration for Apache +-------------------------------- + +The following configuration can be included (and adjusted) in an Apache +VirtualHost configuration: + + # Define the URL of the webbox served by the Apache server: + # http://<servername>/testbox + Alias /testbox /var/www/webbox + + # Actual location of files to be served + FcgidInitialEnv WEBBOX_PATH /home/testbox + + # Title of the Webbox + FcgidInitialEnv WEBBOX_NAME Testbox + + # Maximum transfer size supported is defined by this Fcgid parameter. + # Note that the actual filesize will be smaller due to different + # encoding schemes + FcgidMaxRequestLen 100000000 + + # The following makes the FastCGI application part of Webbox available + # to the user. The static HTML pages of webbox always access the + # FastCGI part via http://<servername>/bin/ + ScriptAlias /bin/ /usr/lib/webbox/ + <Directory "/usr/lib/webbox"> + SetHandler fcgid-script + + AllowOverride None + Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch + # Order allow,deny + # Allow from all + Require all granted + </Directory> + + +Contact +------- + +Reichwein IT <mail@reichwein.it> + |