readme.txt

   1 COMPILING\r
   2 ---------\r
   3 Compiling FMS requires CMake, and pthreads.  Other required libraries are\r
   4 bundled with FMS.\r
   5 \r
   6 To compile, run these commands from the source directory:\r
   7 cmake .\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.\r
  12 \r
  13 UPGRADING\r
  14 ---------\r
  15 It is always a good idea to make copies of your current FMS installation before\r
  16 continuing.  First shut down FMS and then replace the binary and template.htm\r
  17 with those from the new version.  You may keep the same database unless\r
  18 otherwise noted.\r
  19 \r
  20 INSTALLATION\r
  21 ------------\r
  22 Place the binary and template.htm in a directory of your choice.  On the first\r
  23 run, a database file will also be created in this directory.  Make sure the\r
  24 user that runs FMS has read/write access to this directory.\r
  25 \r
  26 RUNNING\r
  27 -------\r
  28 You may run FMS in console mode by running the binary directly.  If you are\r
  29 running *nix and would like to run as a daemon, use the -d argument.  On\r
  30 Windows, -i will install FMS as a service, and -u will uninstall the service.\r
  31 \r
  32 EXITING\r
  33 -------\r
  34 To exit FMS running in console mode, press CTRL+C while at the console.  You\r
  35 can also use the shutdown button on the web interface to close FMS.  As a last\r
  36 resort, you may kill the process.\r
  37 \r
  38 WEB INTERFACE\r
  39 -------------\r
  40 By default, a web interface for administration will be running at http://\r
  41 localhost:8080.  You can use the interface to configure and administer FMS.\r
  42 \r
  43 NNTP CONFIGURATION\r
  44 ------------------\r
  45 By default, the NNTP server will listen on port 1119.  Configure your\r
  46 newsreader to connect to the machine running FMS on this port.  Use the web\r
  47 interface to create an identity and use the name of the identity as the\r
  48 username for the newsgroup account.  The email address may be anything, as it\r
  49 is discarded when posting messages.\r
  50 \r
  51 POSTING MESSAGES\r
  52 ----------------\r
  53 Use must set your newsreader to use UTF-8 when posting messages.  Any non-text\r
  54 attachment to the message will be stripped.  Text attachments will be inlined\r
  55 with the message body.  Cross posting is fine, but remember that each identity\r
  56 can set a limit to the number of boards each message may be cross posted to.\r
  57 \r
  58 CONTROL BOARDS\r
  59 --------------\r
  60 Control boards are special boards that will add/remove trust from an identity.\r
  61 Create control boards in the web interface, and then reply to an identity's\r
  62 message to a control board to change the trust of the identity as per the\r
  63 settings for the board.  You may cross post to a regular board and a control\r
  64 board with the same message.  The control boards will be stripped from the\r
  65 message before inserting into Freenet.\r
  66 \r
  67 FREESITES\r
  68 ---------\r
  69 Each identity has the option to publish a freesite.  A generic HTML template\r
  70 called site-template.htm is used to insert the site.  You can customize the\r
  71 template by placing an HTML file called identityname-template.htm in the same\r
  72 directory as the fms binary.  In the template, the string [LINKS] will be\r
  73 replaced by a <ul> list of links and [CONTENT] will be replaced by the page\r
  74 content.  The Freesite will be inserted once a day and contain your last 10\r
  75 posts and your trust list if you are publishing it.  The site will be inserted\r
  76 to a USK accessible via: USK@yourpublickey.../fms/0/\r
  77 \r
  78 TRUST\r
  79 -----\r
  80 Trust is the most important element of FMS.  It determines which identities you\r
  81 will download messages from and thus your overall experience.  Do not give\r
  82 trust to arbitrary identities.  Pick whom you trust wisely.  The settings for\r
  83 minimum trust before downloading messages and trust lists can be changed on the\r
  84 web interface.\r
  85 \r
  86 A note on NULL trust:  If you neither trust or distrust an identity, they will\r
  87 have NULL trust (no trust at all).  You will download messages and trust lists\r
  88 from identities with NULL peer trust as long as the local trust level is above\r
  89 your configured minimum.  You will also download messages from identities with\r
  90 NULL local message trust (the peer message trust must be NULL or > your\r
  91 configured minimum as well), but you will not download trust lists from\r
  92 identities with NULL local trust list trust.\r