Upgrading notes
From SynchroEdit
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.4 to 0.4.7/0.5
The 0.5 release of SynchroEdit has adopted a more standardized file hierarchy, and files have thus been moved around a bit. If you are upgrading an existing installation, you will need to move your customized files around a bit. The simplest way to do this is to first perform the alterations described below to your existing SynchroEdit installation:
Upgrading
Current file-system layout (your current set up):
client/ client files client/colourmod/ colourmod related files client/graphics/ SynchroEdit client graphics client/i18n/ language files server/ server source files sserve/ server compiled class files
You may have the client directory in one place and the server directory in another and the sserve directory in a third -- that's fine. Make the following changes:
- Create the directory src in the client folder, and move all files (including the colourmod, graphics, and i18n folders) into it.
- Do the exact same thing in the server folder. Create src and move all the .java files into it.
- Rename sserve to synchroedit.
You should now have a layout akin to this:
client/ client directory client/src/ client source files client/src/colourmod/ colourmod related files client/src/graphics/ SynchroEdit client graphics client/src/i18n/ language files server/ server directory server/src/ server source files synchroedit/ server compiled class files
Starting the server will now require that you do java synchroedit.Main rather than java sserve.Main, so any scripts or similar that you've made need to be updated to reflect this change.
After you've done the above, extract the 0.5 version files on top of the existing files, replacing all files where prompted. After that you may want to take a look at the changes to the config file synchroedit.rc:
Configuration file changes
The following configuration directives have been added in SynchroEdit 0.4.7/0.5:
accessFile External reference to access-related directives. indentStrip Whether to strip indenting and similar.
The accessFile is meant to eventually be the place where more sensitive stuff is stored, such as passwords and similar. It is not as of the 0.5 release required that you do this, however.
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
