tuning the index cache
[citadel.git] / citadel / sysconfig.h
index 588796f48d1960dfb837e47e828342b66dee166f..068ad88da6011e3a750ba2756bd000f3840dd511 100644 (file)
@@ -1,62 +1,18 @@
 /*
- * $Id$
+ * Tuning of various parameters of the system.
+ * Normally you don't want to mess with any of this.
  *
+ * Copyright (c) 1987-2018 by the citadel.org team
+ *
+ * This program is open source software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  */
 
-/****************************************************************************/
-/*                  YOUR SYSTEM CONFIGURATION                               */
-/* Set all the values in this file appropriately BEFORE compiling any of the*/
-/* C programs. If you are upgrading from an older version of Citadel/UX, it */
-/* is vitally important that the #defines which are labelled "structure size*/
-/* variables" are EXACTLY the same as they were in your old system,         */
-/* otherwise your files will be munged beyond repair.                       */
-/****************************************************************************/
-
-/* $Id$ */
-
-/* NOTE THAT THIS FILE IS MUCH, MUCH SMALLER THAN IT USED TO BE.
- * That's because the setup program now creates a citadel.config file with
- * all of the settings that don't really need to be in a header file.
- * You can now run setup whenever you want, and change lots of parameters
- * without having to recompile the whole system!
- */
-
-/*
- * If you want to keep a transcript of all multiuser chats that go across
- * your system, define CHATLOG to the filename to be saved to.  Otherwise,
- * set CHATLOG to "/dev/null".
- */
-#define CHATLOG                "chat.log"
-
-/* 
- * S_KEEPALIVE is a watchdog timer.  It is used to send "keep
- * alive" messages to the server to prevent the server from assuming the
- * client is dead and terminating the session.  30 seconds is the recommended
- * value; I can't think of any good reason to change it.
- */
-#define S_KEEPALIVE    30
-
-/*
- * This is the command that gets executed when a user hits <E>nter message:
- * presses the <E>nter message key.  The possible values are:
- *   46 - .<E>nter message with <E>ditor
- *   4  - .<E>nter <M>essage
- *   36 - .<E>nter message with <A>scii
- * Normally, this value will be set to 4, to cause the <E>nter message
- * command to run Citadel's built-in editor.  However, if you have an external
- * editor installed, and you want to make it the default, set this to 46
- * to make it use your editor by default.
- */
-#define DEFAULT_ENTRY          4
-
-
-/*
- * Logging level to use if none is specified on the command line.
- */
-#define DEFAULT_VERBOSITY      9
-
-
-
 /*
  * NLI is the string that shows up in a <W>ho's online listing for sessions
  * that are active, but for which no user has yet authenticated.
 #define SIZ            4096
 
 /*
- * SMTP delivery retry rules (all values are in seconds)
- *
- * If delivery of a message via SMTP is unsuccessful, Citadel will try again
- * after SMTP_RETRY_INTERVAL seconds.  This interval will double after each
- * unsuccessful delivery, up to a maximum of SMTP_RETRY_MAX seconds.  If no
- * successful delivery has been accomplished after SMTP_GIVE_UP seconds, the
- * message will be returned to its sender.
+ * If the body of a message is beyond this size, it will be stored in
+ * a separate table.
  */
-#define        SMTP_RETRY_INTERVAL     900     /* 15 minutes */
-#define SMTP_RETRY_MAX         43200   /* 12 hours */
-#define SMTP_GIVE_UP           432000  /* 5 days */
+#define BIGMSG         1024
 
 /*
- * Who bounced messages appear to be from
+ * SMTP delivery timeouts (measured in seconds)
+ * If outbound SMTP deliveries cannot be completed due to transient errors
+ * within SMTP_DELIVER_WARN seconds, the sender will receive a warning message
+ * indicating that the message has not yet been delivered but Citadel will
+ * keep trying.  After SMTP_DELIVER_FAIL seconds, Citadel will advise the
+ * sender that the deliveries have failed.
  */
-#define BOUNCESOURCE           "Citadel Mail Delivery Subsystem"
+#define SMTP_DELIVER_WARN      14400           // warn after four hours
+#define SMTP_DELIVER_FAIL      432000          // fail after five days
 
 /*
- * This variable defines the amount of network spool data that may be carried
- * in one server transfer command.  For some reason, some networks get hung
- * up on larger packet sizes.  We don't know why.  In any case, never set the
- * packet size higher than 4096 or your server sessions will crash.
+ * Who bounced messages appear to be from
  */
-#define IGNET_PACKET_SIZE      4000
+#define BOUNCESOURCE           "Citadel Mail Delivery Subsystem"
 
 /*
  * The names of rooms which are automatically created by the system
  */
 #define BASEROOM               "Lobby"
 #define MAILROOM               "Mail"
+#define SENTITEMS              "Sent Items"
 #define AIDEROOM               "Aide"
 #define USERCONFIGROOM         "My Citadel Config"
-#define USERCALENDARROOM       "My Calendar"
+#define USERCALENDARROOM       "Calendar"
+#define USERTASKSROOM          "Tasks"
+#define USERCONTACTSROOM       "Contacts"
+#define USERNOTESROOM          "Notes"
+#define USERDRAFTROOM          "Drafts"
+#define USERTRASHROOM          "Trash"
 #define PAGELOGROOM            "Sent/Received Pages"
 #define SYSCONFIGROOM          "Local System Configuration"
 #define SMTP_SPOOLOUT_ROOM     "__CitadelSMTPspoolout__"
 
+/*
+ * Where we keep messages containing the vCards that source our directory.  It
+ * makes no sense to change this, because you'd have to change it on every
+ * system on the network.  That would be stupid.
+ */
+#define ADDRESS_BOOK_ROOM      "Global Address Book"
+
 /*
  * How long (in seconds) to retain message entries in the use table
  */
-#define USETABLE_RETAIN                604800L         /* 7 days */
+#define USETABLE_RETAIN                864000L         /* 10 days */
+
+/*
+ * The size of per-thread stacks.  If set too low, citserver will randomly crash.
+ */
+#define THREADSTACKSIZE                0x100000
+
+/*
+ * How many messages may the full text indexer scan before flushing its
+ * tables to disk?
+ */
+#define FT_MAX_CACHE           25