readme.txt

   1 COMPILING\r
   2 ---------\r
   3 Compiling FMS requires CMake, Poco ( version >=1.2.9 ) and iconv if you want to\r
   4 do charset conversion.  Other required libraries are bundled with FMS.\r
   5 \r
   6 To compile, run these commands from the source directory:\r
   7 cmake -D I_HAVE_READ_THE_README=ON .\r
   8 make\r
   9 \r
  10 If you want to use the bundled SQLite3 library, add a -D USE_BUNDLED_SQLITE=ON\r
  11 to the cmake command.  Use of the bundled SQLite3 library is on by default when\r
  12 compiling on a Mac.  To turn off charset conversion to UTF-8 when sending\r
  13 messages, add a -D DO_CHARSET_CONVERSION=OFF.  Compiling with charset\r
  14 conversion turned on is recommended.  If you would like to compile using the\r
  15 alternate captchas, add a -D ALTERNATE_CAPTCHA=ON to the cmake command line.\r
  16 This option requires the FreeImage library to be installed.\r
  17 \r
  18 UPGRADING\r
  19 ---------\r
  20 *ALWAYS* make a copy of your current FMS installation before continuing.  First\r
  21 shut down FMS, make a copy of the directory, and then replace all files except\r
  22 the database with those from the new version.  You may keep the same database\r
  23 unless otherwise noted in the release information.\r
  24 \r
  25 INSTALLATION\r
  26 ------------\r
  27 Place the binary, any templates, and the fonts and images directories in a\r
  28 directory of your choice.  Windows users may need to download the runtime DLLs\r
  29 available from the fms Freesite and place in the fms directory if they are not\r
  30 already installed on the system.  On the first run, a database file will also\r
  31 be created in this directory.  Make sure the user that runs FMS has read/write\r
  32 access to this directory.\r
  33 \r
  34 RUNNING\r
  35 -------\r
  36 You may run FMS in console mode by running the binary directly.  You can view\r
  37 available command line options by typing /help on Windows and --help on other\r
  38 platforms.  If you are running *nix and would like to run as a daemon, use the \r
  39 --daemon argument.  On Windows, /registerService will install FMS as a service,\r
  40 and /unregisterService will uninstall the service.  Use the /displayName=name\r
  41 argument when installing the service to set the service name to whatever you\r
  42 want.  You will need to manually start the service unless you change the\r
  43 startup type in the service properties.\r
  44 \r
  45 If you are experiencing a problem with FMS that you can't solve, and you've\r
  46 already rebooted your machine, restarted FMS, and have reproduced the problem\r
  47 with a brand new database, follow these instructions.  Set the logging option\r
  48 to trace and restart FMS.  Create a post on the fms group with a descriptive\r
  49 subject and a body that contains the operating system you are using, along with\r
  50 a description of the problem, what you have tried already, if you are using a\r
  51 precompiled binary, the startup lines from the log file as well as the portion\r
  52 that corresponds to the problem you are experiencing, and any other information\r
  53 you have that pertains to the problem.  Make sure to anonymize any IP addresses,\r
  54 host names, subnet masks, and keys from the log that you don't want people to\r
  55 know about.\r
  56 \r
  57 EXITING\r
  58 -------\r
  59 To exit FMS running in console mode, press CTRL+C while at the console.  You\r
  60 can also use the shutdown button on the web interface to close FMS.  As a last\r
  61 resort, you may kill the process.\r
  62 \r
  63 WEB INTERFACE\r
  64 -------------\r
  65 By default, a web interface for administration will be running at http://\r
  66 localhost:8080.  You can use the interface to configure and administer FMS.\r
  67 There is also a forum built into the web interface so you can read and send\r
  68 messages without needing to use a newsreader.\r
  69 \r
  70 NNTP CONFIGURATION\r
  71 ------------------\r
  72 By default, the NNTP server will listen on port 1119.  Configure your\r
  73 newsreader to connect to the machine running FMS on this port.  Use the web\r
  74 interface to create an identity and use the name of the identity as the\r
  75 username for the newsgroup account.  The email address may be anything, as it\r
  76 is discarded when posting messages.\r
  77 \r
  78 POSTING MESSAGES\r
  79 ----------------\r
  80 You must set your newsreader to use UTF-8 when posting messages unless you have\r
  81 compiled with charset conversion turned on.  All headers of the message that\r
  82 aren't needed will be stripped and all headers necessary for the proper sending\r
  83 of the message will be replaced with sanitized ones.  Any non-text attachment\r
  84 to the message will be inserted as a regular file and the key added to the body\r
  85 of the message when received.  Keep the attachments small, as the message can't\r
  86 be inserted until all attachments are inserted.  Text attachments will be\r
  87 inlined with the message body.  Cross posting is fine, but remember that each\r
  88 identity can set a limit to the number of boards each message may be cross\r
  89 posted to.\r
  90 \r
  91 CONTROL BOARDS\r
  92 --------------\r
  93 Control boards are special boards that will add/remove trust from an identity.\r
  94 Create control boards in the web interface, and then reply to an identity's\r
  95 message to a control board to change the trust of the identity as per the\r
  96 settings for the board.  You may cross post to a regular board and a control\r
  97 board with the same message.  The control boards will be stripped from the\r
  98 message before inserting into Freenet.\r
  99 \r
 100 FREESITES\r
 101 ---------\r
 102 Each identity has the option to publish a freesite.  A generic HTML template\r
 103 called site-template.htm is used to insert the site.  You can customize the\r
 104 template by placing an HTML file called identityname-template.htm in the same\r
 105 directory as the fms binary.  In the template, the string [LINKS] will be\r
 106 replaced by a <ul> list of links and [CONTENT] will be replaced by the page\r
 107 content.  [IDENTITYNAME] will be replaced by the name of the identity inserting\r
 108 the Freesite.  The Freesite will be inserted once a day and contain your last\r
 109 10 posts and your trust list if you are publishing it.  The site will be\r
 110 inserted to a USK accessible via: USK@yourpublickey.../fms/0/\r
 111 \r
 112 You may add extra files to your Freesite by creating a file called identityname-\r
 113 files.txt that contains a list of files to add to the Freesite.  There should\r
 114 be one file per line, and the path to each file may be absolute or relative to\r
 115 the working directory, but you MUST use / as the path separator.  Files cannot\r
 116 be named index.htm, trustlist.htm, or files.htm.\r
 117 \r
 118 TRUST\r
 119 -----\r
 120 Trust is the most important element of FMS.  It determines which identities you\r
 121 will download messages from and thus your overall experience.  Do not give\r
 122 trust to arbitrary identities.  Pick whom you trust wisely.  The settings for\r
 123 minimum trust before downloading messages and trust lists can be changed on the\r
 124 web interface.\r
 125 \r
 126 You must have a local identity created before you can set trust levels.  Even\r
 127 if you don't want to post messages, you must still create an identity, but you\r
 128 do not have to announce it.  This way, no-one will know about that identity and\r
 129 you will be able to set trust.  If you have multiple identities, each with\r
 130 different trust levels for peers, the highest trust level set for a peer will\r
 131 determine if messages/trust lists are downloaded from them.\r
 132 \r
 133 A note on NULL trust:  If you neither trust or distrust an identity, they will\r
 134 have NULL trust (no trust at all).  You will download messages and trust lists\r
 135 from identities with NULL peer trust as long as the local trust level is at or\r
 136 above your configured minimum.  You will also download messages from identities\r
 137 with NULL local message trust (the peer message trust must be NULL or >= your\r
 138 configured minimum as well), but you will not download trust lists from\r
 139 identities with NULL local trust list trust.\r
 140 \r
 141 NNTP EXTENSIONS\r
 142 ---------------\r
 143 The following commands are available through the NNTP connection.  The client\r
 144 must have authenticated for the commands to work.  Comments MUST be surrounded\r
 145 by ".\r
 146 \r
 147 XSETTRUST MESSAGE userid@keypart val\r
 148 XSETTRUST TRUSTLIST userid@keypart val\r
 149 XSETTRUST MESSAGECOMMENT userid@keypart "comment"\r
 150 XSETTRUST TRUSTLISTCOMMENT userid@keypart "comment"\r
 151 \r
 152 Responses:\r
 153 2xx Trust Set\r
 154 4xx Unknown ID or other error\r
 155 5xx Syntax error\r
 156 \r
 157 XGETTRUST MESSAGE userid@keypart\r
 158 XGETTRUST TRUSTLIST userid@keypart\r
 159 XGETTRUST PEERMESSAGE userid@keypart\r
 160 XGETTRUST PEERTRUSTLIST userid@keypart\r
 161 \r
 162 Responses:\r
 163 2xx val\r
 164 4xx Unknown ID or other error\r
 165 5xx Syntax error\r
 166 \r
 167 XGETTRUSTLIST\r
 168 trust values will be 0 to 100 or can be the string "null" without quotes.\r
 169 \r
 170 Responses:\r
 171 2xx Trust List Follows\r
 172 userid@keypart TAB messagetrust TAB trustlisttrust TAB peermessagetrust TAB peertrustlisttrust TAB messagecomment TAB trustlistcomment\r
 173 .\r
 174 4xx other error\r