For current development news see our blog...
-
- Requirements
-
- Installation
-
- Update
-
- Optimize Javascript & CSS
-
- Optional features
- 5.1. Bugreportsystem
-
- Protecting userfiles
##1. Minimum Requirements##
You need to install Opal on your server.
##2. Installation##
-
- Clone this repository into your webservers document root.
-
- Create the directories 'tmp'.
-
- Make the dir 'tmp' writeable by the webserver
-
- Rename config.example.php to config.php
-
- Edit config.php
-
- Recommended: Run
make compile
(See 4.)
- Recommended: Run
-
- Recommended: Enable gzip compression (See 5.)
-
- Upload it to your server
##3. Update##
-
- Run
git pull
- Run
-
- Recommended: Run
make compile
(See 4.)
- Recommended: Run
-
- Edit config.php
-
- Upload it to your server
##4. Optimize Javascript & CSS##
###4.1. Requirements### For Javascript Optimization you will need a JRE like OpenJDK or Java
For CSS Optimization you will need Sass
###4.2. How to###
- For optimizing both: Run
make compile
- For optimizing Javascript: Run
make compile-js
- For optimizing CSS: Run
make compile-css
###4.3. Why?### This optimization fastenes the speed of the PHP-Webopal on old PCs and/or smartphones/mobiles.
###4.4. What if I dont want to do this?###
If you don't want to use the optimized versions, there are fallback CSS and Javascript available, which will be chosen, if you never run make compile
.
Please note, that once you did run make compile
you will need to run it after each update or delete the following files:
- js/jquery-*.min.js
- js/script.min.js
- css/style.css
##4.5. Enable gzip compression## In order to shrink server load, you are able to enable gzip compression:
-
- Rename .htaccess.example to .htaccess
-
- Adjust the paths in .htaccess (Please note that absolute Paths are necessary!)
##5. Optional features##
###5.1. Bugreportsystem###
We implemented an bugreportsystem, which will give your visitors the possibility of reportings bugs or ideas directly in WebOpal.
-
- Get a keypair for recaptcha from Recaptcha.net
-
- Paste the keys in your config.php file
-
- Add your github username and password in your config.php
-
- Edit
$ISSUEUSER
and$ISSUEREPO
in your config.php
- Edit
-
- Set
$BUGREPORT
fromfalse
totrue
in your config.php
- Set
##Protecting userfiles##
###Deny access to userfiles with lighttpd###
Just paste the following code into your /etc/lighttpd/lighttpd.conf
$HTTP["url"] =~ "/tmp/files|/tmp/uploads/tmp|/userfiles|/tmp/users" {
url.access-deny = ( "" )
}
###Deny access to userfiles with .htacess###
Create a .htaccess file with the following content
deny from all
in the following directorys:
/tmp/files/
/tmp/userfiles/
/tmp/uploads/
Create another .htaccess in the /tmp/ directory and fill it with this:
<FilesMatch /users>
Order deny, allow
Deny from all
</FilesMatch>