Coderun PHP Encoder manual

Contents

Introduction
How do I use Coderun PHP Encoder?
Troubleshooting while encoding
Encoding and testing your codes
Distributing your scripts
ChangeLog

Back

Introduction

You can encode your php source code before distribution without worrying about the others who might want to copy or steal your php source code. With Coderun PHP Encoder v1.0, you can make your php source code to be unreadable.

With the releases of later versions, which is only accessible in the presence of a paid-for Alangor Program Studio publishing license.

Back

How do I use Coderun PHP Encoder?

Installation

1. Extract the zip files into a folder like "coderun" and CHMOD 777 the "coderun" folder.
2. Upload/Copy the folder and contents to your online server or your localhost server.
   
3. CHMOD 777 or write enable the folders "encoded" and "process" and the file "coderun.php".
   
4. Copy the files which you want to encode into the folder "files".
   
5. Open web browser and run the file call "index.php".

Online help
On each page if you click on some of the options (underlined) you will get more detailed instructions of what they do.

PHP ZLIB library
Please Note: You need the ZLIB library installed. If you do not have this, you will not be able to use all of the functions of CODERUN. It is strongly recommended that you try to install the ZLIB module on your server (to keep up to date) and for the best encode options. If you have Windows version of PHP it SHOULD come with zlib. To check, just do a PHPINFO(); on your server and look for ZLIB library. NOTE: For more information on zlib, please go to : http://www.gzip.org/zlib/

Back

Troubleshooting while encoding

WRITE ERRORS
When setting up the CODERUN PHP Encoder on some servers you may encounter a write error. Usually CODERUN will let you know. If you get a write error message, you will need to write enable (eg: CHMOD 777) the folder that CODERUN specifies. It is because CODERUN puts all of the encoded files into the "encoded" folder and it stores process in the "process" folder.

Windows 2000/2003/XP
You may need to write enable the folder that CODERUN with the "encoded" and "process" folders and you need to have IUSR rights.

Back

Encoding and testing your codes

Encode options
Whatever encode options you choose for one page. It will also be applied to any other page you encode. For example, if you choose an expiry date for one file, then this will apply to all the other pages. This also applies to the unlock key.

Encode multiple folders
CODERUN now encode multiple folders. Be careful when using this option as it will encode every file type that you specify within all subfolders under the folder you specified. Make sure you don't encode a top level folder (eg: c drive, for windows users). Your files should be in the "files" folder preferably to avoid encode problems.

Testing your codes
If you want to test your files before distributing. We strongly recommended that you make a copy of your encoded files and test your COPY. The reason is the state of the decoder file (eg: coderun.php) is altered when you enter your unlock key. If you send your files with the altered decoder file (after testing it yourself). Your end client will NOT be
asked to enter the unlock key.

Alternatively, you can prepare your files for distribution immediately after you encode them in their un-altered encoded state.

Back

Distributing your scripts

You only need one copy of the coderun.php file (or your renamed decoder file) in the same folder as your files. If you use subfolders CODERUN will automatically put the decoder file into each subfolder for you.

IMPORTANT: To make sure your script runs properly, the decorder file (coderun.php) needs to be write enabled (CHMOD 777). If you are distributing your files. You will need to instruct your client to write enable the decoder file. Usually this is the only requirement but sometimes your client may also need to CHMOD the directory that your code is in to 777. This may be necessary if they do not have write permission to their root directory. Another way is to get them to into a subfolder with write permission.

If you would prefer not to ask your client to CHMOD 777 the decoder file. Then you can unlock the script BEFORE you send it. But this means they will not be able to enter an unlock key.

Preserving Your CONFIG files. If you want some of your files to still remain editable by your client. Remember to copy and paste your original config file over the top of the encoded one before distributing.

If you use the ZLIB compression option your client MUST also have ZLIB installed on their system. It is recommended that you do use this option. If they have trouble installing ZLIB. Then you could send them a standard encoded version. USUALLY, most client do have ZLIB or do not have much trouble installing it.

Compatibility: When you send someone your own codes (even WITHOUT encode). They need to have at least the SAME version of PHP as you or better. This way to let you know for sure that your codes should work on their server. Remember CODERUN encoded files will work on PHP 4.1 or later.

Additional Notes
The "encoded" folder is where CODERUN stores your latest encoded files. The "files" folder is a folder where you can place your files to make it easy for you to specify a relative path to your files when encoding.

Known problems
For files that have been included: If an included file references file-related super globals eg: dirname(__FILE__); they may not always work properly.

Back

ChangeLog

Version 1.0 (2006-05-09)

Back