* Replaced all "Citadel/UX" references with "Citadel"
[citadel.git] / citadel / docs / windows-readme.txt
1 README for Windows distribution
2 -------------------------------
3
4 Installation:
5
6   To install Citadel for Windows, run the citadel-X.XX.exe file.  It is
7   recommended that you do not change the installation folder.  Unlike the
8   Unix version, you do NOT need to run Citadel's setup utility before
9   starting the server.  However, the system operator will be set to the
10   first user who creates an account on the server, so you need to login
11   immediately.
12
13   Setup will fail if the Citadel server is running when you install/upgrade.
14   You will need to login to your Citadel server and issue the <.A>ide
15   <T>erminate <N>ow command to stop the server before upgrading Citadel.
16   This will be fixed in a future release.
17
18   At the present time you must restart your computer to start the Citadel
19   server.  This will be fixed in a future release.
20
21 Removal:
22
23   To remove Citadel for Windows, go to Start > Control Panel > Add/Remove
24   Programs, click Citadel, then click Add/Remove (or Change/Remove).  Your
25   server data (users, messages, etc.) will NOT be removed.  To remove these
26   files, delete the C:\Program Files\Citadel\data directory.
27
28 Known Issues in Citadel for Windows:
29
30 * Calendaring support is not included.  Status:  TO_BE_FIXED
31
32 * Citadel may not run properly if the installation directory is changed from
33   C:\Program Files\Citadel.  It is strongly recommended that you do not
34   change the installation directory.  Status:  TO_BE_FIXED
35
36 * The "weekly" maintenance script does not run.  Since it is a Unix script,
37   there is no way to run it in Windows.  The main effect you will see is that
38   no server objects expire.  If you wish you can expire them manually.  To do
39   this, enter the following server commands (using the @ key in the text
40   client or the appropriate advanced command in WebCit):  Status:  TO_BE_FIXED
41
42   EXPI users
43   EXPI rooms
44   EXPI messages
45   EXPI visits
46   EXPI usetable
47
48 * Sessions can be disconnected if you read the citadel-debug.txt using a
49   Cygwin program while the server is running.  In addition, the file is
50   written in Unix text format.  To view this file, use a Windows editor
51   which understands Unix text files, such as WordPad.  (Notepad won't work.)
52   Status:  RELNOTE