You are not logged in.
Register - Password remember
  Automatic
  

Website

Now, let's install Jappix on your server. Then, you will learn how to configure it.

Get the package

The Jappix application installation is really simple: download the latest release on the project website and extract the tarball/zip archive.

Then, put the extracted files in your web directory. You can send it to your server with a FTP client, or with SSH.

When this is done, open your Web browser and display Jappix. Then, follow the install tool to process the next step.

Note: Openfire users may use this plugin to setup Jappix. Remember that we don't own this plugin, which means that the bundled Jappix might be out of date.

Main configuration

Service name

Write here the service name of your Jappix setup. e.g.: Free chat

Service description

Write here the service description of your Jappix setup. e.g.: A free chat to discuss with your friends!

Resource

The default connection resource for the users who login through your Jappix node. Can be changed by the user using the connection form. This applies to Jappix Desktop, Jappix Mobile and Jappix Mini. e.g.: user@server.tld/Resource (stamp).

Lock the host

Choose whether to allow users to login to the XMPP server they want or not. You should enable it if using a restricted BOSH (ejabberd/Prosody/Openfire's internal BOSH).

Anonymous mode

Choose whether to allow anonymous mode or not, using the defined anonymous XMPP host. This applies to Jappix Desktop, Jappix Mobile and Jappix Mini.

Registration allowed

Choose whether to allow the registration of new accounts through your Jappix node or not. If disabled, the registration forms will be locked on Jappix Desktop and Jappix Mini.

Use a proxy

Choose whether to use a built-in PHP BOSH proxy or not. Remember it does not replace a BOSH server. It was only made to allow the usage of cross-domain features of Jappix Mini using obsolete browsers. It is also a good way to use Jappix on standards ports (80 and 443), and to use a secured connection (HTTPS).

Warning: it is known that some users cannot get the proxy to work (Windows servers are affected). If so, you should try installing cURL for PHP. If it does not fix your issue, you will have to disable it through Jappix Manager (Configuration tab).

Notice: it is not recommended to use the built-in proxy with lots of users. Each user generates a PHP process which consumes about 5Mio of memory, and every PHP servers have a maximum number of active processes (generally 4). Consider using this Jappix feature if you are only a few people using the same service!

Manager link

Choose whether to show a link to the manager or not. It is recommended you disable it if you are providing a public service.

Groupchats to join

Enter the groupchats to be joined when the Jappix Desktop user comes online, separate each one with a comma. e.g.: postpro@muc.jappix.com, mini@muc.jappix.com

Encryption

Choose whether your server provide HTTPS support or not (will hide the secured version link if not).

HTTPS storage

Choose whether to allow file storage through HTTPS or not (for social channel and message attachments). If not checked, all the files will be stored using HTTP.

Force HTTPS

Choose whether to force HTTPS or not (will redirect HTTP to HTTPS). If enabled, Jappix Manager will still be accessible using HTTP if you need to disable it (in case of HTTPS issues).

Compression

Choose whether to compress files or not, using GZip. This also applies to JS and CSS files optimization. It is strongly recommended to enable it, because it will significantly reduce your bandwidth usage.

Warning: it is known that powerless servers or overloaded servers cannot generate Jappix cache, due to our fabulous JS optimization script (PHP timeouts after 30 seconds). Remember that after the cache is generated, a static file is served really fastly. To fix it, disable the compression. You can also disable it manually by passing the compression tag value from on to off in the main.xml file, located in ./store/conf/.

Hosts configuration

Main host

Write here the main XMPP host. If you want to setup your own XMPP server, please read XmppServer. e.g.: server.tld.

Notice: if you want to use the Jappix.com service, write: jappix.com. To use it, you must also use our own BOSH service.

Groupchat host

Write here the groupchat XMPP host (MUC). If you want to setup your own XMPP server, please read XmppServer. e.g.: muc.server.tld or conference.server.tld.

Notice: if you want to use the Jappix.com service, write: muc.jappix.com.

Pubsub host

Write here the Pubsub XMPP host. If you want to setup your own XMPP server, please read XmppServer. e.g.: pubsub.server.tld.

Notice: if you want to use the Jappix.com service, write: pubsub.jappix.com.

Hosts configuration

Anonymous host

Write here the anonymous XMPP host. If you want to setup your own XMPP server, please read XmppServer. e.g.: anonymous.server.tld or anon.server.tld.

Notice: if you want to use the Jappix.com service, write: anonymous.jappix.com. To use it, you must also use our own BOSH service.

Directory host

Write here the directory XMPP host (VJUD). If you want to setup your own XMPP server, please read XmppServer. Remember only ejabberd implements this, if you are using another XMPP server, you'd better use our own VJUD service e.g.: vjud.server.tld or users.server.tld.

Notice: if you want to use the Jappix.com service, write: vjud.jappix.com.

BOSH host

Write here the BOSH XMPP host. If you want to setup your own BOSH server, please read BoshServer. e.g.: http://server.tld:5280/http-bind.

Notice: if you want to use the Jappix.com service, write: https://bind.jappix.com/.

Configuration tricks

Some configuration options are not accessible through the Web interface, because they are not usually in use or may disturb some users.

The folder containing the configuration files is: ./store/conf/

Dynamic protocol

If you want Jappix to use either HTTP or HTTPS (depending on the protocol in use by the user) for any configuration address, replace http:// or https:// by {PROTOCOL}://. Please note that saving configuration through the manager will erase it. e.g.: {PROTOCOL}://sub.server.tld/

Main BOSH host

You can define a special BOSH host to be used with the main Jappix (Desktop and Mobile), which will not apply to Jappix Mini (the default BOSH host will be used).

Open the hosts.xml file and change the <bosh_main /> element content with the desired server address. e.g.: http://bosh.server.tld/

Notice: applying a value to this field will result in inactivating the default BOSH field!

Mini BOSH host

You can define a special BOSH host to be used with Jappix Mini, which will not apply to Jappix Desktop and Jappix Mobile (the default BOSH host will be used).

Open the hosts.xml file and change the <bosh_mini /> element content with the desired server address. e.g.: http://bosh.mini.server.tld/

Warning: be sure that your BOSH service allows POST and GET requests (GET requests using JSON+XML for the cross-domain hack).

Notice: applying a value to this field will result in inactivating the default BOSH field!

Static host

You can define a static host, which will serve static files via the Get.php API. It is recommended to use it when you have a great load to distribute the service on different servers.

Open the hosts.xml file and change the <static /> element content with the desired server address. e.g.: http://static.server.tld/

Upload host

You can define an upload host, which will be used to serve them to users. Remember that your main server will still handle uploaded files (because of cross-domain issues for upload process). File will just be shared on the upload domain you defined.

Open the hosts.xml file and change the <upload /> element content with the desired server address. e.g.: http://upload.server.tld/