COMPILING\r
---------\r
-Compiling FMS requires CMake, and pthreads. Other required libraries are\r
-bundled with FMS.\r
+Compiling FMS requires CMake, pthreads and iconv if you want to do charset\r
+conversion. Other required libraries are bundled with FMS.\r
\r
To compile, run these commands from the source directory:\r
cmake .\r
make\r
\r
If you want to use the bundled SQLite3 library, add a -D USE_BUNDLED_SQLITE=ON\r
-to the cmake command.\r
+to the cmake command. To do charset conversion to UTF-8 when sending messages,\r
+add a -D DO_CHARSET_CONVERSION=ON.\r
\r
UPGRADING\r
---------\r
It is always a good idea to make copies of your current FMS installation before\r
-continuing. First shut down FMS and then replace the binary and template.htm\r
-with those from the new version. You may keep the same database unless\r
-otherwise noted.\r
+continuing. First shut down FMS and then replace the binary and templates with\r
+those from the new version. You may keep the same database unless otherwise\r
+noted.\r
\r
INSTALLATION\r
------------\r
-Place the binary and template.htm in a directory of your choice. On the first\r
+Place the binary and any templates in a directory of your choice. On the first\r
run, a database file will also be created in this directory. Make sure the\r
user that runs FMS has read/write access to this directory.\r
\r
username for the newsgroup account. The email address may be anything, as it\r
is discarded when posting messages.\r
\r
-Posting Messages\r
+POSTING MESSAGES\r
----------------\r
-Use must set your newsreader to use UTF-8 when posting messages. Any non-text\r
-attachment to the message will be stripped. Text attachments will be inlined\r
-with the message body. Cross posting is fine, but remember that each identity\r
-can set a limit to the number of boards each message may be cross posted to.\r
+You must set your newsreader to use UTF-8 when posting messages. Any non-text\r
+attachment to the message will be inserted as a regular file and the key added\r
+to the body of the message when received. Keep the attachments small, as the\r
+message can't be inserted until all attachments are inserted. Text attachments\r
+will be inlined with the message body. Cross posting is fine, but remember\r
+that each identity can set a limit to the number of boards each message may be\r
+cross posted to.\r
\r
CONTROL BOARDS\r
--------------\r
board with the same message. The control boards will be stripped from the\r
message before inserting into Freenet.\r
\r
+FREESITES\r
+---------\r
+Each identity has the option to publish a freesite. A generic HTML template\r
+called site-template.htm is used to insert the site. You can customize the\r
+template by placing an HTML file called identityname-template.htm in the same\r
+directory as the fms binary. In the template, the string [LINKS] will be\r
+replaced by a <ul> list of links and [CONTENT] will be replaced by the page\r
+content. The Freesite will be inserted once a day and contain your last 10\r
+posts and your trust list if you are publishing it. The site will be inserted\r
+to a USK accessible via: USK@yourpublickey.../fms/0/\r
+\r
+You may add extra files to your Freesite by creating a file called identityname-\r
+files.txt that contains a list of files to add to the Freesite. There should\r
+be one file per line, and the path to each file may be absolute or relative to\r
+the working directory, but you MUST use / as the path separator. Files cannot\r
+be named index.htm, trustlist.htm, or files.htm.\r
+\r
TRUST\r
-----\r
Trust is the most important element of FMS. It determines which identities you\r
will download messages from and thus your overall experience. Do not give\r
-trust to arbitrary identities. Pick whom you trust wisely. There settings for\r
+trust to arbitrary identities. Pick whom you trust wisely. The settings for\r
minimum trust before downloading messages and trust lists can be changed on the\r
web interface.\r
\r
+You must have a local identity created before you can set trust levels. Even\r
+if you don't want to post messages, you must still create an identity, but you\r
+do not have to announce it. This way, no-one will know about that identity and\r
+you will be able to set trust. If you have multiple identities, each with\r
+different trust levels for peers, the highest trust level set for a peer will\r
+determine if messages/trust lists are downloaded from them.\r
+\r
A note on NULL trust: If you neither trust or distrust an identity, they will\r
have NULL trust (no trust at all). You will download messages and trust lists\r
-from identities with NULL peer trust as long as the local trust level is above\r
-your configured minimum. You will also download messages from identities with\r
-NULL local message trust (the peer message trust must be NULL or > your\r
+from identities with NULL peer trust as long as the local trust level is at or\r
+above your configured minimum. You will also download messages from identities\r
+with NULL local message trust (the peer message trust must be NULL or >= your\r
configured minimum as well), but you will not download trust lists from\r
identities with NULL local trust list trust.\r
projects / fms.git / blobdiff