Doc updates.
diff --git a/quickstart.txt b/quickstart.txt --- a/quickstart.txt +++ b/quickstart.txt @@ -5,7 +5,7 @@ ===Configuration=== # Click on the "View" link below to view (and edit) the configuration. -# Set the "FMS ID" to the human readable part of your FMS ID (everything before the '@'). +# Set the "FMS name" to the human readable part of your FMS ID (everything before the '@'). # Set the FMS Private SSK to your private FMS SSK (see below if you don't know how to find this). # Adjust any other values as necessary. If you're running FMS and Fred on the same machine on the default ports this shouldn't be necessary. # Click the "Done" button to save the configuration changes. @@ -21,7 +21,7 @@ to save your FMS indentities to a file. # In the text editor of your choice, open the file you saved above and look for the Name and PrivateKey values for the identity you want to use. -In the example identity snippet below, the FMS ID value would be:\\ +In the example identity snippet below, the FMS Name value would be:\\ SomeUser and the FMS Private Key would be: \\ diff --git a/readme.txt b/readme.txt --- a/readme.txt +++ b/readme.txt @@ -1,4 +1,4 @@ -20110205 +201102012 djk@isFiaD04zgAgnrEC5XJt1i4IE7AkNPqhBG5bONi6Yks WARNING: @@ -19,8 +19,23 @@ REQUIREMENTS: ant java 1.5 or better Access to a running Freenet Node and FMS daemon. +A reasonably recent version of freenet.jar + +FMS CONFIGURATION: +By default the prototype uses the "biss.test000" FMS group. +Make sure FMS is configured to save messages to this group. + +On the FMS Boards maintenance page: +http://127.0.0.1:18080/boards.htm + +Search for "biss.test000" and make sure "Save Received Messages" is checked. + +If you can't find the group, add it. BUILD: +Copy freon.jar into ./alien/libs + +run: ant jar RUN STAND ALONE: @@ -28,17 +43,25 @@ RUN STAND ALONE: Look at http://127.0.0.1:8083 with your web browser. -Click on the "View" Configuration link and set the "FMS Private SSK" and "FMS ID" fields. +Click on the "View" Configuration link and set the "FMS Private SSK" and "FMS name" fields. If you want you can use the "Export" button on the Configuration page to export your configuration to a file. Once you've done that you can start the script with the saved configuration. i.e.: -./script/jfniki.sh path_to_your_saved_config +./script/jfniki.sh path_to_your_saved_confess will start the stand alone app on the same port you used before. -RUN AS A FREENET PLUGIN: +RUNNING STAND ALONE ON WINDOWS: +I don't have access to a Windows machine to test on so I didn't write a .bat. + +Theseus's from FMS reports that you can run stand alone under Windows by copying freshened.jar +and jfniki.jar into the same directory and running: + +java(w) -PP freenet.jar;jfniki.jar fniki.standalone.ServeHttp [jfniki.cfg|port] + +RUN AS A BRENT PLUGIN: Load the jar file from ./build/jar/jfniki.jar Click on the "View" Configuration link and set the "FMS Private SSK" and "FMS ID" fields. @@ -47,8 +70,8 @@ OTHER DOC: See quickstart.txt in this directory (The default page when an empty wiki is displayed). KNOWN ISSUES: -o Pages don't auto-refresh. You need to manually reload to see status changes. - [Freenet ContentFilter is eating meta-refresh??? Fixed now with WikiContentFilter.EXCEPTIONS hack] o "Cancel" sometimes fails. [WORKAROUND: load and unload the plugin / kill restart the stand alone app.] +o FMS Id displays "???" when importing config with non-default FCP host and/or port. + [WORKAROUND: Click "Done", then click view again and the FMS Id should be correctly displayed.] - + LocalWords: SSK jfniki cfg PLUGIN quickstart diff --git a/src/fniki/wiki/WikiApp.java b/src/fniki/wiki/WikiApp.java --- a/src/fniki/wiki/WikiApp.java +++ b/src/fniki/wiki/WikiApp.java @@ -542,7 +542,7 @@ public class WikiApp implements ChildCon sb.append("\n"); sb.append("===Configuration===\n"); sb.append("# Click on the \"View\" link below to view (and edit) the configuration.\n"); - sb.append("# Set the \"FMS ID\" to the human readable part of your FMS ID (everything before the '@').\n"); + sb.append("# Set the \"FMS Name\" to the human readable part of your FMS ID (everything before the '@').\n"); sb.append("# Set the FMS Private SSK to your private FMS SSK (see below if you don't know how to find this).\n"); sb.append("# Adjust any other values as necessary. If you're running FMS and Fred on the same machine on the default ports this shouldn't be necessary.\n"); sb.append("# Click the \"Done\" button to save the configuration changes.\n"); @@ -559,7 +559,7 @@ public class WikiApp implements ChildCon sb.append("\n"); sb.append("# In the text editor of your choice, open the file you saved above and look for the Name and PrivateKey values for the identity you want to use.\n"); sb.append("\n"); - sb.append("In the example identity snippet below, the FMS ID value would be:\\\\ \n"); + sb.append("In the example identity snippet below, the FMS Name value would be:\\\\ \n"); sb.append("SomeUser\n"); sb.append("\n"); sb.append("and the FMS Private Key would be: \\\\ \n"); diff --git a/src/fniki/wiki/child/SettingConfig.java b/src/fniki/wiki/child/SettingConfig.java --- a/src/fniki/wiki/child/SettingConfig.java +++ b/src/fniki/wiki/child/SettingConfig.java @@ -261,7 +261,7 @@ public class SettingConfig implements Mo sb.append(" <td><input type=\"text\" name=\"fmsssk\" size=\"128\" value=\"\" /> </td>\n"); sb.append(" </tr>\n"); sb.append(" <tr>\n"); - sb.append(" <td>FMS name</td>\n"); + sb.append(" <td>FMS Name</td>\n"); sb.append(" <td><input type=\"text\" name=\"fmsid\" value=\"%s\" /> </td>\n"); sb.append(" </tr>\n"); sb.append(" <tr>\n");