COMPILING --------- Compiling FMS requires CMake, Poco ( version >=1.2.9 ) and iconv if you want to do charset conversion. Other required libraries are bundled with FMS. To compile, run these commands from the source directory: cmake -D I_HAVE_READ_THE_README=ON . make Compiling with the bundled SQLite library is on by default. If you do not want to use the bundled SQLite library, add a -D USE_BUNDLED_SQLITE=OFF to the cmake command. To turn off charset conversion to UTF-8 when sending messages, add a -D DO_CHARSET_CONVERSION=OFF. Compiling with charset conversion turned on is recommended. If you would like to compile using the alternate captchas, add a -D ALTERNATE_CAPTCHA=ON to the cmake command line. This option requires the FreeImage library to be installed. Query logging may be turned on by adding a -D QUERY_LOG=ON. This will create a file called query.log in the working directory. Straight SQL statements will be captured, as well as the setup of prepared statements. Each step through a prepared statement is also logged, but the details are not, so there should be no sensitive information in this log file. UPGRADING --------- *ALWAYS* make a copy of your current FMS installation before continuing. First shut down FMS, make a copy of the directory, and then replace all files except the database with those from the new version. You may keep the same database unless otherwise noted in the release information. INSTALLATION ------------ Place the binary, any templates, and the fonts and images directories in a directory of your choice. Windows users may need to download the runtime DLLs available from the fms Freesite and place in the fms directory if they are not already installed on the system. On the first run, a database file will also be created in this directory. Make sure the user that runs FMS has read/write access to this directory. RUNNING ------- You may run FMS in console mode by running the binary directly. You can view available command line options by typing /help on Windows and --help on other platforms. If you are running *nix and would like to run as a daemon, use the --daemon argument. On Windows, /registerService will install FMS as a service, and /unregisterService will uninstall the service. Use the /displayName=name argument when installing the service to set the service name to whatever you want. You will need to manually start the service unless you change the startup type in the service properties. FMS must run a good portion of the day every day to work properly. The slower your Freenet connection is, the longer FMS must be run to find the communications of other identities. You will not have a good experience only running FMS a few hours a day. If you are experiencing a problem with FMS that you can't solve, and you've already rebooted your machine, restarted FMS, and have reproduced the problem with a brand new database, follow these instructions. Set the logging option to trace and restart FMS. Create a post on the fms group with a descriptive subject and a body that contains the operating system you are using, along with a description of the problem, what you have tried already, if you are using a precompiled binary, the startup lines from the log file as well as the portion that corresponds to the problem you are experiencing, and any other information you have that pertains to the problem. Make sure to anonymize any IP addresses, host names, subnet masks, and keys from the log that you don't want people to know about. EXITING ------- To exit FMS running in console mode, press CTRL+C while at the console. You can also use the shutdown button on the web interface to close FMS. As a last resort, you may kill the process. WEB INTERFACE ------------- By default, a web interface for administration will be running at http:// localhost:8080. You can use the interface to configure and administer FMS. There is also a forum built into the web interface so you can read and send messages without needing to use a newsreader. NNTP CONFIGURATION ------------------ By default, the NNTP server will listen on port 1119. Configure your newsreader to connect to the machine running FMS on this port. Use the web interface to create an identity and use the name of the identity as the username for the newsgroup account. The email address may be anything, as it is discarded when posting messages. POSTING MESSAGES ---------------- You must set your newsreader to use UTF-8 when posting messages unless you have compiled with charset conversion turned on. All headers of the message that aren't needed will be stripped and all headers necessary for the proper sending of the message will be replaced with sanitized ones. Any non-text attachment to the message will be inserted as a regular file and the key added to the body of the message when received. Keep the attachments small, as the message can't be inserted until all attachments are inserted. Text attachments will be inlined with the message body. Cross posting is fine, but remember that each identity can set a limit to the number of boards each message may be cross posted to. CONTROL BOARDS -------------- Control boards are special boards that will add/remove trust from an identity. Create control boards in the web interface, and then reply to an identity's message to a control board to change the trust of the identity as per the settings for the board. You may cross post to a regular board and a control board with the same message. The control boards will be stripped from the message before inserting into Freenet. FREESITES --------- Each identity has the option to publish a freesite. A generic HTML template called site-template.htm is used to insert the site. You can customize the template by placing an HTML file called identityname-template.htm in the same directory as the fms binary. In the template, the string [LINKS] will be replaced by a