This article assumes that you have already compiled and have a running Snipe server. Since compiling the editor will also produce a Neko interpreter file, you will need a configured Apache webserver with Neko support enabled either through mod_neko or mod_tora.

We will use the test project editor as an example of an actual project editor. The editor for the test project is located in "examples/testProject/edit/" directory. The source code consists of a single file since it only uses the core components.

haxe index.hxml

Running this command will compile the project editor and produce the "index.n" file. Take a look inside of "index.hxml". You will need to change paths for the core templates in your case or the compilation will fail.

The "index.n" file needs to go into the directory accessible by webserver. You will also need the configuration file in "cfg/hweb.cfg" (don't forget to configure the webserver to disallow access to it from outside!) and all directories located in "snipe/edit/www/" except "tpl/" ("css/", "font/", "img/", "js/"). If your editor runs but instead of the usual Snipe editor design you see black text on gray background, it means that the webserver cannot find the images and Javascript files.

This is how a working default installation of the editor should look:

There is a somewhat limited second option if you do not want to set up the Apache webserver. Neko comes with a webserver included and the editor can run through that. This option can be useful during the development but won't do in production. You can run the webserver with this command:

nekotools server -p 3000

You should run this in a directory with "index.n" file, configuration directory and all directories with static editor content. By default the webserver uses localhost port 2000 so the "-p" option will move it to port 3000 because default Snipe cache server configuration also uses localhost port 2000.

Note that the Neko webserver does not support file upload.

The PostgreSQL database needs to be set up. In particular, the database table containing the editor users (called EditorUsers) should exist. By default the database contains only one user with login "admin" and password "123". This user has all permissions. Needless to say, this should be changed. You can read about adding and modifying editor users in User Authentication article.

If everything is done correctly, you should see an authentication form on going to the editor script through the web browser. After entering the login and password you should see the main page of the editor.

Next: First Steps