Upgrading notes

From SynchroEdit

(Difference between revisions)
Jump to: navigation, search
Revision as of 02:15, 17 June 2006 (edit)
Kalle Alm (Talk | contribs)

← Previous diff
Revision as of 02:16, 17 June 2006 (edit)
Kalle Alm (Talk | contribs)

Next diff →
Line 24: Line 24:
The following configuration directives have been '''added''' in SynchroEdit 0.3.9: The following configuration directives have been '''added''' in SynchroEdit 0.3.9:
- servicePass ''The response service password.''+ servicePass '''The response service password.'''
- serviceLocalOnly ''Whether the response service should only serve localhost.''+ serviceLocalOnly '''Whether the response service should only serve localhost.'''
- servicePort ''The port on which the response service should listen for requests.''+ servicePort '''The port on which the response service should listen for requests.'''
- autoCreateInstance ''When a new session is set up, and the instance file doesn't exist, it is created.''+ autoCreateInstance '''When a new session is set up, and the instance file doesn't exist, it is created.'''
- portRange ''A range of ports in which the response service should assign sessions.''+ portRange '''A range of ports in which the response service should assign sessions.'''
- startDefault ''Whether a session called "default" should be created on start-up.''+ startDefault '''Whether a session called "default" should be created on start-up.'''
- preserveDefault ''Whether the default session should be preserved when the server is rebooted.''+ preserveDefault '''Whether the default session should be preserved when the server is rebooted.'''
- docTypeDeclaration ''The DOCTYPE declaration, which appears at the top of the XHTML file.''+ docTypeDeclaration '''The DOCTYPE declaration, which appears at the top of the XHTML file.'''
- shutdownAfterLastUser ''Whether sessions should, by default, shut down after the last user leaves.''+ shutdownAfterLastUser '''Whether sessions should, by default, shut down after the last user leaves.'''
- executeUponTermination ''Execute a server-side command when a session closes.''+ executeUponTermination '''Execute a server-side command when a session closes.'''
- postDataUponTermination ''Perform a HTTP POST when a session closes.''+ postDataUponTermination '''Perform a HTTP POST when a session closes.'''
- debugLevel ''The verbosity of debugging output.''+ debugLevel '''The verbosity of debugging output.'''
- debugProtIn ''Whether to display incoming protocol statements to console.''+ debugProtIn '''Whether to display incoming protocol statements to console.'''
- debugProtOut ''Whether to display outgoing protocol statements to console.''+ debugProtOut '''Whether to display outgoing protocol statements to console.'''
All these changes are documented in more detail in the synchroedit.rc.sample file located in the server directory of the source. All these changes are documented in more detail in the synchroedit.rc.sample file located in the server directory of the source.

Revision as of 02:16, 17 June 2006

Contents

Notes on upgrading SynchroEdit

This page is here to give you some insights into what you will need to do when upgrading your SynchroEdit installations to new(er) versions of SynchroEdit. Please start reading from the version of SynchroEdit which you have currently deployed, rather than merely reading the newest entry, as there may be essential things you miss if you don't.

From 0.3 to 0.3.9/0.4

The 0.4 release of SynchroEdit handles things significantly different from how the 0.3 version does. Since it is inherently multi-document oriented, SynchroEdit 0.4 no longer requires you to tell it which ports to serve authentication and communication on. Instead, the client will now auto-detect this by talking to the response service.

While the console interface has been significantly improved in this upgrade, most interaction has been moved to the response service interface, which you can read more about here.

Further information to come on what you can do with this.

Configuration directives

The following configuration directives are obsolete as of SynchroEdit 0.3.9: (they are ignored)

instance     The filename of the instance, e.g. devbox.xhtml
authport     The port number for authentication requests
port         The port number for communication

The following configuration directives have been renamed as of SynchroEdit 0.3.9: (they still work as they are, but warnings will appear)

requires_authentication → requiresAuthentication
server_model            → serverModel
local_path              → localPath

The following configuration directives have been added in SynchroEdit 0.3.9:

servicePass             The response service password.
serviceLocalOnly        Whether the response service should only serve localhost.
servicePort             The port on which the response service should listen for requests.
autoCreateInstance      When a new session is set up, and the instance file doesn't exist, it is created.
portRange               A range of ports in which the response service should assign sessions.
startDefault            Whether a session called "default" should be created on start-up.
preserveDefault         Whether the default session should be preserved when the server is rebooted.
docTypeDeclaration      The DOCTYPE declaration, which appears at the top of the XHTML file.
shutdownAfterLastUser   Whether sessions should, by default, shut down after the last user leaves.
executeUponTermination  Execute a server-side command when a session closes.
postDataUponTermination Perform a HTTP POST when a session closes.
debugLevel              The verbosity of debugging output.
debugProtIn             Whether to display incoming protocol statements to console.
debugProtOut            Whether to display outgoing protocol statements to console.

All these changes are documented in more detail in the synchroedit.rc.sample file located in the server directory of the source.

From 0.2 to 0.3

The default SynchroEdit client talks with the server via a set of PHP scripts which reside in the client directory. These scripts are called "the bridge" between the client and the server, as they seamlessly allow the server to communicate with clients via XMLHttpRequests, despite the limitations in this system, almost as if it was a regular socket connection. For various reasons, we chose to move from PHP to Perl/CGI in the 0.3 release of SynchroEdit, As such it is important that you 1) ensure you have Perl installed, and 2) ensure that your Apache configuration (or whatever web server you are using) allows CGI scripts in the client directory.

For Apache2, the sample Apache2 site-file has been updated to reflect the 0.3 client settings. We encourage you to check it out and adapt your own configurations to how it is set up.

Personal tools