Here is a raw link to the GitHub version.

Fri May 02 2025 12:22:31 UTC from Motobike Subject: Re: Citadel docker and lighttld documentation

Hi Tamer,

how does it look like with lighttld ? Can you explaine ? Found nothing on your page. 

Thanks

 

Greetings

Mike

Fr Apr 04 2025 11:24:22 UTC von TaMeR Betreff: Citadel docker and lighttld documentation

 

I have posted docs on my site but they are also available as markdown on github.

 

Hi Tamer,

how does it look like with lighttld ? Can you explaine ? Found nothing on your page. 

Thanks

Greetings

Mike

Fr Apr 04 2025 11:24:22 UTC von TaMeR Betreff: Citadel docker and lighttld documentation

 

I have posted docs on my site but they are also available as markdown on github.

Hi there,

i created a little Motobike Community Setup with Citadel. Main focus is the E-Mail and Boards. 

Spam mails and hacking is a major problem at all. 

Here is my setup for Citadel:

[Internet] ---- SMTP ----> [Postfix]

                            |

                            | Milter (Spam-Check)

                            v

                         [Rspamd]

                            |

                            | Result (e.g. Spam-Score)

                            v

                         [Postfix]

                            |

                            | Log-Analyse (Suspicious IPs)

                            v

                         [Fail2ban] ----> [Firewall: IP block]

                            |

                            | LMTP (E-Mail-delivery)

                            v

                         [Citadel]

                            |

                            | IMAP/POP3/Webinterface

                            v

                         [User]

RspamD works nice with citadel

Important:

#

# Citdael Mailserver

#

 

[smtp-citadel]

 

enabled = true

filter = citadel-smtp

port = smtp,ssmtp,submission

logpath = /var/log/syslog

maxretry = 5

findtime = 300

bantime = 3600

backend = auto

allowipv6 = auto

 

[smtp-submission]

enabled = true

filter = citadel-submission

port = submission,587

logpath = /var/log/syslog

maxretry = 5

findtime = 300

bantime = 86400

backend = auto

allowipv6 = auto

 

[webcit]

 

enabled = true

filter = webcit

logpath = /var/log/syslog

maxretry = 5

findtime = 300

bantime = 3600

allowipv6 = auto

I have posted docs on my site but they are also available as markdown on github.

Citadel via Docker Installation Manual
==============

We will use `mail` as hostname, `mail.example.net` as our domain,
and `203.0.113.1` as our public facing IP address on this page for the citadel server.
Replace with your own.

Pre-Install
----------
Before you start set your DNS to point your domain to the servers IP.
How to do that is out of this manuals scope.
___

Installation
------------
Next we will set some variables, *replace* with your domain and IP address then execute following in your bash shell. Following will not work in a fish shell, you will have to use the set command.

```sh
export CIT_HOST_NAME=mail
export CIT_DOMAIN_NAME=mail.example.net
export CIT_IP_ADDRESS=203.0.113.1
```

```
mkdir -p /usr/local/citadel
mkdir -p /usr/local/webcit/.well-known
echo "127.0.1.1   $CIT_DOMAIN_NAME   $CIT_HOST_NAME">>/etc/hosts
echo "$CIT_IP_ADDRESS   $CIT_DOMAIN_NAME   $CIT_HOST_NAME">>/etc/hosts
```

Now your */etc/hosts* file should look something like following. We only added the last two lines. Make sure `127.0.1.1` is a unique IP address in the first column. If you have a IP6 address you may add it as well.

```sh
#
# /etc/hosts: static lookup table for host names
#

#<ip-address>        <hostname.domain.tld ]]>https://uncensored.citadel.org/readfwd?go=Citadel%20Documentation?start_reading_at=2099505559Wed, 22 Jan 2025 10:33:12 -00002099505559@Uncensored

Hi,

I'm new to Citadel. I set up my first instance around month ago and it runs like a charm.

Now I face issues with SPAM messages. Integration with SpamAssassin is kind-of working. I have 2 issues:

1) Citadel is rejecting SPAM messages, so there is no option to check headers and configure filters;

2) Ham messages are not "enriched" with X-Spam headers. I don't know is it issue with Citadel or SA configuration.

I would be greatful for any suggestions. Where is configuration for spam handling?

Have a great day,

Wojtek

Thx, for your Feedback. I'was look in documentation, is there somewhere some howto upgrading a existing citadel instance, what is install with the easyinstall script?

Sun May 07 2023 21:41:57 EDT from IGnatius T Foobar Subject: Re: some smal question

There is no fixed limit to the size of an individual user's message store.
The limit to the size of the *entire* system's message store is currently 256 terabytes.

hello,

I didn't find a mailbox size parameter in the documentation. Is mailbox size only limited by free space on the hard drive?

have a nice day ...

somebody alive?

si senior

Sun Nov 20 2022 08:06:51 AM EST from zelgomer Subject: Re: shut down citadel service, backup database and restart citadel service

$ systemctl stop citadel.service

Is that not an example?

--to see your current active system resources

$ systemd-cgls

-- to stop citadel.service (after you've logged off the server as admin and booted all the users off)

$ systemctl stop citadel.service

-- probably can leave webcit active since citadel.service is stopped and your gonna just backup the databases

-- but you can turn em off it makes you feel better

$ systemctl stop webcit-http.service

$ systemctl stop webcit-https.service

-- create an archive backup on your usb key you just plugged in (dev/sda1) [pre-format the usb key to ext4]

-- pay attention to the usb path, it might not be dev/sda1, it could be media/something...

-- copy with archive flag

$sudo cp -a /usr/local/citadel /dev/sda1/

-- start everything back up

$ systemctl start webcit-https.service

$ systemctl start webcit-http.service

$ systemctl start citadel.service

-- log back in as admin and make sure everything is happy.

would be nice to have some prototype commands for a few Linux distros put into the doc, like on this link

https://www.citadel.org/systemd.html

raspberry pi uses

$ sudo service citadel stop

$ sudo service citadel start

there are a few references in the documentation to stop the server for various reasons (like to make a backup) but not a single command line example can be found anywhere!

Was coming here to add this - but I see you already did. I'll post any thing I discover here in this format, from now on. 

Sun Dec 13 2020 08:39:22 EST from warbaby Subject: openssl genrsa -out citadel.key 1024/2048

In how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html

Committed and pushed..

In how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html

Committed and pushed..

I hope we are talking about the same glitch. I am talking about the glitch related to Subject: header issue,

that was allegedly fixed, and it was. But there is a glitch now that displays "(no subject)" in the Subject header if viewed in Mail folder view.

I guess I should post instead to Citadel Support because it is not a documentation issue...

Sat Nov 28 2020 10:43:54 EST from IGnatius T Foobar Subject: Re: platonov's cit_docs_01.zip

"We fixed ... the glitch."

Wed Nov 25 2020 03:41:14 AM EST from warbaby Subject: platonov's cit_docs_01.zip

Okay now I see it [aging eyes + long thread]

Thank you.   Am reviewing. 

We have a small glitch to fix in the shared repo for citadel.org, then these updates will be flowing again.

 

"We fixed ... the glitch."

Wed Nov 25 2020 03:41:14 AM EST from warbaby Subject: platonov's cit_docs_01.zip

Okay now I see it [aging eyes + long thread]

Thank you.   Am reviewing. 

We have a small glitch to fix in the shared repo for citadel.org, then these updates will be flowing again.

Okay now I see it [aging eyes + long thread]

Thank you.   Am reviewing. 

We have a small glitch to fix in the shared repo for citadel.org, then these updates will be flowing again.

Since like most sites nowadays are redirecting the http port 80 requests to https/443 .. we need to add -L or --location to the curl request.

It should be

curl -L http://easyinstall.citadel.org/install | bash

I've got this done locally, just waiting for the permissions fix to push it out.

I see the attachment file, cit_docs_01.zip in your message. Let me attach it to this post, just in case...

It wasn't meant to be an "official" submission. It is just a few sentences outlining the issue with using aliases, meant for you to look at, if you feel like it, and decide for yourself what to do with it. The same thing is for those 2 other docs. If someone finds it of value, they are welcome to it. Else...

Sun Nov 22 2020 12:37:39 EST from warbaby Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

> I'll attach the initial version of my citadel navigator (cit_nav.html) that describes this issue.

I did not see anything attached.  If you are going to submit something, please make a new post for it explaining exactly what it is and where it goes.

I like your inline reply comment style for most things, but in this case, your input is getting buried.  It's better to have one post per topic, so I can find it, address it, and close it out.

Thanks for all your help!

:)

 

Sat Nov 21 2020 01:03:58 PM EST from platonov Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

Btw, are you planning on adding TOC to the System Administration Manual page? That'll take some work...

Let me include my version of the System Administration Manual and Application Layer Protocol

They have been updated and some things are fixed.

There is also a documentation issue with email addresses and aliases, how it works and what is "no - no". The existing documentation that I have seen is not quite clear and/or incomplete and, as a result, I had to spend nearly 2 days trying to figure it out. A Royal Waste of Time! I tried to test all possible combinations of things in order to figure out how it works and I hope now it is more or less complete.

I'll attach the initial version of my citadel navigator (cit_nav.html) that describes this issue.

(See Citadel quirks -> Email addresses and aliases)

You might want to update the following doc with that information from cit_nav.html.

How do I create two public email adrresses with same recipient but in different domains?

 

Sat Nov 21 2020 08:13:09 EST from platonov Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

Well, I did a quick look at the System Administration Manual page and it has been changed. I hope you did not take out some valuable stuff... :)

Otherwise, great to see that strike-through stuff gone.

Fri Nov 20 2020 13:07:28 EST from warbaby Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

This is fixed now, but not yet deployed. Most of the citadel nodes stuff is deprecated, so I just removed it, and fixed the rest of the links.

Check the diff below.

https://code.citadel.org/?p=www.citadel.org.git;a=commitdiff;h=df2523fe2ebd0ec261c1c6383ef1d78980af17f0

Sun Nov 15 2020 10:35:32 AM EST from warbaby Subject: System Administration Manual, 1728-1750 cruft

Logging this here for the time being..

Sun Nov 15 2020 10:11:29 AM EST from warbaby @ Uncensored Subject: Re: System Administration Manual needs fixing

Logged, I'll get to this as soon as I can.

Sun Nov 15 2020 04:42:01 AM EST from platonov @ Uncensored Subject: System Administration Manual needs fixing

There is an error in System Administration Manual:

https://citadel.org/system_administration_manual.html
in section Defining neighbor nodes, (lines 1728-1750) inside the <code> section. It has to do with unescaped angle brackets <> creating problems for web browser.

As a result all the rest of the document is displayed with strikethrough/strikeout text and it might look like it is a deliberate attempt to comment out an older version of document, no longer current and, therefore, not correct.

So, all the angle brackets better be properly escaped so that they are not mistakenly interpreted as valid code.

Also, the code needs to be placed inside the <pre>...</pre>

> I'll attach the initial version of my citadel navigator (cit_nav.html) that describes this issue.

I did not see anything attached.  If you are going to submit something, please make a new post for it explaining exactly what it is and where it goes.

I like your inline reply comment style for most things, but in this case, your input is getting buried.  It's better to have one post per topic, so I can find it, address it, and close it out.

Thanks for all your help!

:)

Sat Nov 21 2020 01:03:58 PM EST from platonov Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

Btw, are you planning on adding TOC to the System Administration Manual page? That'll take some work...

Let me include my version of the System Administration Manual and Application Layer Protocol

They have been updated and some things are fixed.

There is also a documentation issue with email addresses and aliases, how it works and what is "no - no". The existing documentation that I have seen is not quite clear and/or incomplete and, as a result, I had to spend nearly 2 days trying to figure it out. A Royal Waste of Time! I tried to test all possible combinations of things in order to figure out how it works and I hope now it is more or less complete.

I'll attach the initial version of my citadel navigator (cit_nav.html) that describes this issue.

(See Citadel quirks -> Email addresses and aliases)

You might want to update the following doc with that information from cit_nav.html.

How do I create two public email adrresses with same recipient but in different domains?

 

Sat Nov 21 2020 08:13:09 EST from platonov Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

Well, I did a quick look at the System Administration Manual page and it has been changed. I hope you did not take out some valuable stuff... :)

Otherwise, great to see that strike-through stuff gone.

Fri Nov 20 2020 13:07:28 EST from warbaby Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

This is fixed now, but not yet deployed. Most of the citadel nodes stuff is deprecated, so I just removed it, and fixed the rest of the links.

Check the diff below.

https://code.citadel.org/?p=www.citadel.org.git;a=commitdiff;h=df2523fe2ebd0ec261c1c6383ef1d78980af17f0

Sun Nov 15 2020 10:35:32 AM EST from warbaby Subject: System Administration Manual, 1728-1750 cruft

Logging this here for the time being..

Sun Nov 15 2020 10:11:29 AM EST from warbaby @ Uncensored Subject: Re: System Administration Manual needs fixing

Logged, I'll get to this as soon as I can.

Sun Nov 15 2020 04:42:01 AM EST from platonov @ Uncensored Subject: System Administration Manual needs fixing

There is an error in System Administration Manual:

https://citadel.org/system_administration_manual.html
in section Defining neighbor nodes, (lines 1728-1750) inside the <code> section. It has to do with unescaped angle brackets <> creating problems for web browser.

As a result all the rest of the document is displayed with strikethrough/strikeout text and it might look like it is a deliberate attempt to comment out an older version of document, no longer current and, therefore, not correct.

So, all the angle brackets better be properly escaped so that they are not mistakenly interpreted as valid code.

Also, the code needs to be placed inside the <pre>...</pre>

 

 

 

 

 

As you will see here, this device was a source of trouble...

[image attached] This docu-wiki hierarchical javascript thingy is where we lost some content.

There are two problems going on here [which result in missing content for citadel.org, and generally making things difficult to find].

1. Links like this did not survive the conversion process: http://citadel.org/doku.php/doku.php?id=documentation:start
2. Wayback Machine didn't handle those urls very well either.

If you right click the url shown in these and.. open in new tab/window.. you get something like

http://doku.php/documentation:webcit:start  [missing http://citadel.org, so nothing is ever found..]

It is possible to retrieve these by hand editing the docu.php link [adding the prefix "http://citadel.org"] and hit enter.

Then, the Wayback Machine can find the page.

A lot of the sendcommand documentation people are looking for is under "Application Layer Protocol". 

I'm working to recover these now, but if anybody wants to rummage around and dig out some clean html for anything missing on citadel.org .. I would certainly appreciate the help.

The last reliable archives appear to be from 2017, although, you might want to look around.  The pages are there, you might have to hand edit the url.  it's a little difficult that way to find out what the last snapshot is.. but this date appears to be intact.

https://web.archive.org/web/20171229062531/http://www.citadel.org/doku.php/doku.php?id=documentation:start

I removed the deprecated Citadel nodes stuff, and that basically took care of the issue you raised.

The underlining problem is missing </a> tags from the conversion of links from the docuwiki format..

There are a few more, and I'm getting too them.

Sat Nov 21 2020 08:13:09 AM EST from platonov Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

Well, I did a quick look at the System Administration Manual page and it has been changed. I hope you did not take out some valuable stuff... :)

Otherwise, great to see that strike-through stuff gone.

Fri Nov 20 2020 13:07:28 EST from warbaby Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

This is fixed now, but not yet deployed. Most of the citadel nodes stuff is deprecated, so I just removed it, and fixed the rest of the links.

Check the diff below.

https://code.citadel.org/?p=www.citadel.org.git;a=commitdiff;h=df2523fe2ebd0ec261c1c6383ef1d78980af17f0

Sun Nov 15 2020 10:35:32 AM EST from warbaby Subject: System Administration Manual, 1728-1750 cruft

Logging this here for the time being..

Sun Nov 15 2020 10:11:29 AM EST from warbaby @ Uncensored Subject: Re: System Administration Manual needs fixing

Logged, I'll get to this as soon as I can.

Sun Nov 15 2020 04:42:01 AM EST from platonov @ Uncensored Subject: System Administration Manual needs fixing

There is an error in System Administration Manual:

https://citadel.org/system_administration_manual.html
in section Defining neighbor nodes, (lines 1728-1750) inside the <code> section. It has to do with unescaped angle brackets <> creating problems for web browser.

As a result all the rest of the document is displayed with strikethrough/strikeout text and it might look like it is a deliberate attempt to comment out an older version of document, no longer current and, therefore, not correct.

So, all the angle brackets better be properly escaped so that they are not mistakenly interpreted as valid code.

Also, the code needs to be placed inside the <pre>...</pre>

 

 

 

 

This is a reply to platonov from a previous topic, but I wanted to break it out to address markdown specifically.

The point of the markdown isn't to strand us on some island amidst the wreckage of yet another framework du-jour. [It's to avoid that. Even the css style and framework should be easily replaceable.]

Markdown will only used as a transitional, or storage format. Nobody will ever actually have to deal with or see it.

Even so it's a much better format for accepting "user contributed tutorials" than to ask them to submit things in html. [Imagine the junk that could come along with that!  All kinds of localized and internal styles.... the horrors I have seen inside modern HTML.. ]

But with markdown, we already have content separate from layout, and that's the whole point. 

And anybody can write it, since it's only a text file.

It's main purpose is that the end result is not html alone, it's both html and Latex.  

[And try as we might, we just can't do html -> tex (with all the divs and classes intact) and ever have it come out right. Been there, done that.  It makes a serious mess. It's far cleaner to start the "head" as markdown, and keep the conversion chain simple.  Trust me on this.  Its not an arbitrary decision.  Modern CSS classes are getting complex because you have all the guts in them for various viewport and screen widths. ]

With markdown, (and a very few select html tags):

<code>

#!/bin/bash

echo "foo";

</code>

Anything like this can be passed directly to Latex "verbatim" environment. [For latex, we need less formatting, not more.]

can be pandoc(ed) to html (as a fragment).. [then wrapped in any kind of div tags, even with multiple versions if need be]

So it will possible to keep everything from looking exactly the same.. and still have some reasonable styles. 

Therefore the lowest common denominator can't be html/css. It must be markdown.  Html/CSS is just too complex to survive the conversion process to latex.

In any case, we're still quite a ways off.  We still have pages sitting on the wayback machine. 

Just thought I'd fill everyone in on this part of the plan.

Btw, are you planning on adding TOC to the System Administration Manual page? That'll take some work...

Let me include my version of the System Administration Manual and Application Layer Protocol

They have been updated and some things are fixed.

There is also a documentation issue with email addresses and aliases, how it works and what is "no - no". The existing documentation that I have seen is not quite clear and/or incomplete and, as a result, I had to spend nearly 2 days trying to figure it out. A Royal Waste of Time! I tried to test all possible combinations of things in order to figure out how it works and I hope now it is more or less complete.

I'll attach the initial version of my citadel navigator (cit_nav.html) that describes this issue.

(See Citadel quirks -> Email addresses and aliases)

You might want to update the following doc with that information from cit_nav.html.

How do I create two public email adrresses with same recipient but in different domains?

Sat Nov 21 2020 08:13:09 EST from platonov Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

Well, I did a quick look at the System Administration Manual page and it has been changed. I hope you did not take out some valuable stuff... :)

Otherwise, great to see that strike-through stuff gone.

Fri Nov 20 2020 13:07:28 EST from warbaby Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

This is fixed now, but not yet deployed. Most of the citadel nodes stuff is deprecated, so I just removed it, and fixed the rest of the links.

Check the diff below.

https://code.citadel.org/?p=www.citadel.org.git;a=commitdiff;h=df2523fe2ebd0ec261c1c6383ef1d78980af17f0

Sun Nov 15 2020 10:35:32 AM EST from warbaby Subject: System Administration Manual, 1728-1750 cruft

Logging this here for the time being..

Sun Nov 15 2020 10:11:29 AM EST from warbaby @ Uncensored Subject: Re: System Administration Manual needs fixing

Logged, I'll get to this as soon as I can.

Sun Nov 15 2020 04:42:01 AM EST from platonov @ Uncensored Subject: System Administration Manual needs fixing

There is an error in System Administration Manual:

https://citadel.org/system_administration_manual.html
in section Defining neighbor nodes, (lines 1728-1750) inside the <code> section. It has to do with unescaped angle brackets <> creating problems for web browser.

As a result all the rest of the document is displayed with strikethrough/strikeout text and it might look like it is a deliberate attempt to comment out an older version of document, no longer current and, therefore, not correct.

So, all the angle brackets better be properly escaped so that they are not mistakenly interpreted as valid code.

Also, the code needs to be placed inside the <pre>...</pre>

 

 

 

 

Well, I did a quick look at the System Administration Manual page and it has been changed. I hope you did not take out some valuable stuff... :)

Otherwise, great to see that strike-through stuff gone.

Fri Nov 20 2020 13:07:28 EST from warbaby Subject: Re: System Administration Manual, 1728-1750 cruft - Fixed.

This is fixed now, but not yet deployed. Most of the citadel nodes stuff is deprecated, so I just removed it, and fixed the rest of the links.

Check the diff below.

https://code.citadel.org/?p=www.citadel.org.git;a=commitdiff;h=df2523fe2ebd0ec261c1c6383ef1d78980af17f0

Sun Nov 15 2020 10:35:32 AM EST from warbaby Subject: System Administration Manual, 1728-1750 cruft

Logging this here for the time being..

Sun Nov 15 2020 10:11:29 AM EST from warbaby @ Uncensored Subject: Re: System Administration Manual needs fixing

Logged, I'll get to this as soon as I can.

Sun Nov 15 2020 04:42:01 AM EST from platonov @ Uncensored Subject: System Administration Manual needs fixing

There is an error in System Administration Manual:

https://citadel.org/system_administration_manual.html
in section Defining neighbor nodes, (lines 1728-1750) inside the <code> section. It has to do with unescaped angle brackets <> creating problems for web browser.

As a result all the rest of the document is displayed with strikethrough/strikeout text and it might look like it is a deliberate attempt to comment out an older version of document, no longer current and, therefore, not correct.

So, all the angle brackets better be properly escaped so that they are not mistakenly interpreted as valid code.

Also, the code needs to be placed inside the <pre>...</pre>

 

 

 

I'll reply in-line...

Thu Nov 19 2020 12:26:48 EST from warbaby Subject: Re: Documentation Navigators and information organization

One of the first things that's being done is to convert all the sources to clean markdown.This was automated, but came out pretty good..

I've evaluated some static site generators, and have considered rolling our own.. but markdown (with tags) is the order of the day for that kind of thing..so anyway..

Well, I tried to stay away from anything that generates the html pages out of some parts or using markdown. I like to keep things as simple and as reliable and as flexible as possible. For example static html pages can be viewed even when you don't have the internet connection. You can simply view them by opening a file://.... All you need is the css style sheets and you don't need any server based page constructing code, like php, to run.

I was thinking about using something php based to construct the pages, but then I felt that you have to loose some freedom in expressing things any way you like it on a different page. You are not tied up to a single rigid or "standard" way of doing anything.

With things like php once you found that page format that you like, you are forced to use it on every single page more or less. Yes, you can argue that nothing prevents you from creating new rules for different pages, but then you are essentially in programming, logic and so on. For example, based on which criteria do you generate some table on one or few pages? And this is just for starters.

That is why I stayed in a strict static html code, where I have full freedom to do anything I please on every single page and one page does not force you to change something for a different page and so on.

I did try to use a wiki kind of base and was initially excited with markup. But then again, all it seemed to create is more work, not less, as strange as it might look.

I think a good division is into these three spheres:

* User manual (Everything from how to change your password, to setting up forwarding and other inbox rules)

* Admin Manual (And all that it entails)

* Developer .. etc.

Even so, there is also the code documentation itself, which I generated with Doxygen, although nobody has seen it yet.

Also under consideration are the creating of of meaningful, SEO optimized urls like

siteroot/user-manual/how-do-i-do-such-and-such.html

The existing paradigm is that most things are faq entries.. so a rewrite of this order is going to be massive upheaval..I have already collected every possible existing URL so we can add redirects for them with nginx.

Yep, having a large number of small, single-item FAQ-like pages is something I tried to stay away from, like from a plague. For one thing, you can not have your FAQ as a single file. You have to be on-line and go get every item separately, which creates more problems for you than it helps anything. Just a simple thing: when your FAQ consists of a number of pages then you can not do a string search in your browser to find all the places where something is mentioned.

So, in the short term, I'll be doing the updates on the main website as is.. and probably setting up a new vhost for the experimental documentation stuff.

I've considered may other FOSS documentation websites, thinking what I liked & what I didn't.  I don't like "cramped" javascripty popouts and things like that..

Yep, EXACTLY. Basically, I don't even like to have a need in js, as such. I view web pages as information and you don't need all those bells and whistles to express anything you want information-vise. Well, pretty much, even though you might find some cases where it would be desirable.

PLAIN HTML.. easily found, easy to cache, super fast, easy to print etc..

Yep, EXACTLY. Plus it works on ANY browser or anything, and you don't need some server side gadgets to see your pages.

Navigation is always important, and a clean topical table of contents.. at some point, I'll start posting my notes here, but feel free to make suggestions anytime.

Spinx or Solr may be options down the road, but we still have a long way to go before that..

If we had better search engine visibility and navigation, they would probably be unnecessary..

 

Mon Nov 16 2020 12:35:30 PM EST from platonov Subject: Documentation Navigators and information organization

This is a response to the citadel support room thread:

Re: MIGR export/import for database recovery/upgrades/selective mods

Great to hear that. Actually, I had plenty of frustration in trying to find good info in Citadel docs and found that it takes WAY too much time to find things that could be found within minutes, if not seconds. Not that the info is not there, but you can't quite get to it and/or find it.

One of the things I found most valuable in any kind of writing, documentation or not, is the extensive TOC, pointing out every thing, be it some "small" issue or "large". Just because something is "small" does not mean it does not deserve to be found in table of contents. Otherwise, if it is THAT small that it "doesn't worth pointing it out", then why did you write it at all to begin with? Basically, all you have to do is to place the "small" things in less significant or noticeable places in TOC or on a deeper tree level.

Just by having the extensive TOC you increase the accessibility and locatability of info by orders of magnitude.

One other thing is local search engine. Why not use, for example, Solr search engine? You can index this entire collection and have every page indexed nearly instantly and have the REAL search engine results and not some quite unintuitive hack imitating the search engine functionality.

In fact, I can give the fully functional search engine code with php driven interface for indexing, search box and the rest of it and you'll have the entire documentation collection searchable in no time.

People underestimate the value and significance of information way too much and end up wasting orders of magnitudes in time, efforts and wasted energy, wasted for nothing.

One simple thing that can be done, and pretty fast, is creation of navigator page. Basically, the navigator page is a regular html page containing links to other places. You don't even have to have any actual information in the nav pages. All you need is links, like a tree structure of typical TOC. That nav page alone can be easily remembered, and, since it has the links to ALL the separate pages, all you need is that nav page to get to ANY info.

And if you have many small pages, each containing a short description of some item, topic, etc., then you create a nested, tree-like structured arrangement, where you do not include every small point in the main index of the navigator, but create a sub-toc.

 

Sun Nov 15 2020 17:37:25 EST from omatnet @ Uncensored Subject: Re: MIGR export/import for database recovery/upgrades/selective mods

Wow, that you so much! This is a great resource and should be on the Citadel website...! I can't believe I've been using Citadel for 8 years now, researching for info and learning to tweak it, and this is the first time I see such a good and comprehensive reference for using the 'sendcommand'

Thank you so much!!!

Sat Nov 14 2020 15:58:11 EST from platonov @ Uncensored Subject: Re: MIGR export/import for database recovery/upgrades/selective mods

Well, I can offer you a couple of key Citadel documents (see attachments here).

They are based on protocol and system_administration_manual. But they have been redone to include the extensive TOC and all sorts of formatting has been changed to make it all look the way I like to see things. Just unzip it and make sure css/main.css is present for the styles to work they way it was intended.

Protocol is actually that "good and detailed 'sendcommand' commands+parameters documentation".

So...

Sat Nov 14 2020 13:31:01 EST from omatnet @ Uncensored Subject: Re: MIGR export/import for database recovery/upgrades/selective mods

Those are very good points. I was never able to find a detailed description of the 'sendcommand' and the commands + parameters it can received (other than the 1-page on the Citadel.org website). If there is some detailed documentation for the 'sendcommand' it could be a good start.

Can anyone direct me/us to a good and detailed 'sendcommand' commands+parameters documentation?

Sat Nov 14 2020 08:16:30 EST from platonov @ Uncensored Subject: MIGR export/import for database recovery/upgrades/selective mods

I'd like to understand the "MIGR export/import" commands a lil bit deeper than a skin-deep level.
It seems to me that MIGR is a pretty flexible and powerful mechanism
for doing things like database repair and/or modification on either the entire database
or its sections: config, user, room, floor, message.

It seems that it also could be used for restoring just database sections or
even a selected few variables, parameters and so on.

For example if there is a database corruption you may loose
your config parameters, in which case you could simply edit
the last good XML created by MIGR export and copy the config
section to a separate XML file which you could then import and thus
recover your system parameters.

Yes, things get tricky when you start dealing with users,
rooms, floors or messages and if you change some things by editing
the XML file, you may create conflicts or loose the entire sections
of the database if yo

 

This [attached file] is a better job of sorting, if anyone would like to have a look, or play around with it. 

This is fixed now, but not yet deployed. Most of the citadel nodes stuff is deprecated, so I just removed it, and fixed the rest of the links.

Check the diff below.

https://code.citadel.org/?p=www.citadel.org.git;a=commitdiff;h=df2523fe2ebd0ec261c1c6383ef1d78980af17f0

Sun Nov 15 2020 10:35:32 AM EST from warbaby Subject: System Administration Manual, 1728-1750 cruft

Logging this here for the time being..

Sun Nov 15 2020 10:11:29 AM EST from warbaby @ Uncensored Subject: Re: System Administration Manual needs fixing

Logged, I'll get to this as soon as I can.

Sun Nov 15 2020 04:42:01 AM EST from platonov @ Uncensored Subject: System Administration Manual needs fixing

There is an error in System Administration Manual:

https://citadel.org/system_administration_manual.html
in section Defining neighbor nodes, (lines 1728-1750) inside the <code> section. It has to do with unescaped angle brackets <> creating problems for web browser.

As a result all the rest of the document is displayed with strikethrough/strikeout text and it might look like it is a deliberate attempt to comment out an older version of document, no longer current and, therefore, not correct.

So, all the angle brackets better be properly escaped so that they are not mistakenly interpreted as valid code.

Also, the code needs to be placed inside the <pre>...</pre>

 

 

Below (and attached) is the sorted grep output for '<h' on the webroot of citadel.org

It is interesting.  This shows us filenames and section headings.. As I mentioned, this makes for a sorting project.

Considering a TOC style of Part, Chapter, Section, Subsection etc.. [Such as in Latex Memoir, scr-book, etc... ]

Considering the nouns Book, Manual, or Guide

As I've mentioned. . I see 3 book/manual/guides.

• User Manual/Guide [Basic stuff, with screenshots, how to change your password or create a room).
• Administrator Guide [This will actually be quite lengthy.. and would include installation, and a lot of recipes and how-tos ]
• Developer Guide [Deailing primarily with the code and how to compile, conventions, etc.. ] with Sections 'Overall', and for each project.

THEN, an additional vhost for Doxygen documentation of the source code.  [Done, just nobody has seen it.. ]

Maybe I will drop these in a spreadsheet, and start officially sorting.

001_module_types.html:14:<h4>User Modules</h4>
 001_module_types.html:4:<h3>Types of Modules</h3>
001_module_types.html:8:<h4>System Modules</h4>
002_coding_style.html:19:<h5>Must DO</h5>
002_coding_style.html:30:<h5>Things your module should/should NOT do</h5>
002_coding_style.html:4:<h4>Module Coding Style</h4>
003_module_init.html:4:<h3>CTDL_MODULE_INIT</h3>
004_api_by_purpose.html:4:<h4>List of API functions arranged by purpose</h4>
after_upgrading_server.html:4:<h1>After upgrading, server fails with "citadel: Cannot install certificate: key values mismatch"</h1>
aidepost.html:14:<h1>DESCRIPTION</h1>
aidepost.html:18:<h1>OPTIONS</h1>
aidepost.html:30:<h1>HISTORY<h2>
aidepost.html:4:<h1>aidepost</h1>
aidepost.html:8:<h1>SYNOPSIS</h1>
apacheproxy.html:161:<h2>LightHTTPD</h2>
apacheproxy.html:164:<h3>Host-based webcit forwarding.</h3>
apacheproxy.html:22:<h3>Apache</h3>
apacheproxy.html:4:<h1>How can I install WebCit so it runs alongside Apache/Nginx/LightHTTPD on port 80 / 443?</h1>
apacheproxy.html:76:<h3>Nginx</h3>
authmodes.html:12:<h2>Self-contained authentication</h2>
authmodes.html:20:<h2>Host system integrated authentication</h2>
authmodes.html:27:<h2>External LDAP - RFC 2307 compliant directory</h2>
authmodes.html:38:<h2>External LDAP - Microsoft Active Directory</h2>
authmodes.html:44:<h2>So, which one should I use?</h2>
authmodes.html:4:<h1>What are the different authentication modes and which one should I use?</h1>
bitlebee.html:126:<h3> Enjoy </h3>
bitlebee.html:16:<h2>irssi</h2>
bitlebee.html:32:<h2>bitlbee</h2>
bitlebee.html:33:<h3>Install bitlbee</h3>
bitlebee.html:39:<h3>Connecting to bitlbee</h3>
bitlebee.html:4:<h1>How do i use Citadel's XMPP/Jabber service with Irssi/Bitlbee?</h1>
bitlebee.html:51:<h3>Setup/register an account password for your new bitlbee account on your machine</h3>
bitlebee.html:64:<h3>Add a xmpp/jabber account</h3>
bitlebee.html:96:<h3>Login and chat</h3>
blacklists_rbls_or_dnsbl.html:4:<h1> Blacklists (RBLs or DNSBL) </h1>
can_i_configure_citadel_to_use_an_anti_virus_program.html:4:<h1> Can I configure Citadel to use an antivirus program? </h1>
can_i_install_citadel_on_a_shared_web_hosting_account.html:4:<h1> Can I install Citadel on a shared web hosting account? </h1>
catchall.html:4:<h2>Can I Create A "CatchAll" Email Address With Citadel?</h2>
chkpw.html:14:<h1>DESCRIPTION</h1>
chkpw.html:19:<h1>EXAMPLES<h2>
chkpw.html:23:<h1>HISTORY<h2>
chkpw.html:4:<h1>chkpw</h1>
chkpw.html:8:<h1>SYNOPSIS</h1>
chrptr.html:14:<h1>DESCRIPTION</h1>
chrptr.html:18:<h1>PARAMETERS</h1>
chrptr.html:26:<h1>RETURNS</h1>
chrptr.html:32:<h1>SEE ALSO</h1>
chrptr.html:34:<h1>HISTORY<h2>
chrptr.html:4:<h1>ChrPtr</h1>
chrptr.html:8:<h1>SYNOPSIS</h1>
citadel_bb.html:11:<h4>Citadel Does Provide</h4>
citadel_bb.html:22:<h4>Citadel Does Not Provide</h4>
citadel_bb.html:31:<h3>Conclusion</h3>
citadel_bb.html:4:<h2>Can I Create a Bulletin Board Like PHPBB or Slashcode With Citadel?</h2>
citadel_bombs_out_with_a_segmentation_fault_during_setup_or_when_i_attempt_to_run._what_should_i_do.html:4:<h1> Citadel bombs out with a segmentation fault during setup or when I attempt to run. What should I do? </h1>
citadel_logo.html:4:<h1>Citadel logo</h1>
citadel_past_present_and_future.html:13:<h2>Origins: the prehistoric era</h2>
citadel_past_present_and_future.html:30:<h2>Breakout: the Internet era</h2>
citadel_past_present_and_future.html:38:<h2>Evolution</h2>
citadel_past_present_and_future.html:4:<h1>Citadel: a storied history</h1>
citadel_past_present_and_future.html:63:<h2>A look towards the future...</h2>
citadel_past_present_and_future.html:6:<i><h2>Editorial note</h2>
citadel_past_present_and_future.html:72:<i><h2>Editorial note</h2>
citadel_sends_my_mail_out_with_a_different_from_than_i_specified_in_my_email_client.html:4:<h1>Citadel Sends My Mail Out With A Different "From:" Than I Specified In My Email Client. </h1>
citadel_with_spamassassin_and_clamav.html:4:<h1>Citadel with SpamAssassin and ClamAV</h1>
citmail.html:14:<h1>DESCRIPTION</h1>
citmail.html:21:<h1>OPTIONS</h1>
citmail.html:30:<h1>DEFAULTS</h1>
citmail.html:40:<h1>HISTORY<h2>
citmail.html:4:<h1>citmail</h1>
citmail.html:8:<h1>SYNOPSIS</h1>
citserver_crashes_when_running_on_debian_linux_when_sending_out_internet_email._fix.html:4:<h1>citserver crashes (when running on Debian Linux) when sending out Internet email.  Fix?</h1>
citserver_fails_to_start_with_a_message_such_as_cdb_dbenv_open_function_not_implemented.html:4:<h1> citserver fails to start with a message such as cdb_*:dbenv->open: Function not implemented </h1>
citserver.html:14:<h1>DESCRIPTION</h1>
citserver.html:21:<h1>OPTIONS</h1>
citserver.html:35:<h1>DEFAULTS</h1>
citserver.html:4:<h1>citserver</h1>
citserver.html:62:<h1>FILES</h1>
citserver.html:78:<h1>HISTORY</h1>
citserver.html:8:<h1>SYNOPSIS</h1>
code_of_conduct.html:4:<h1>Code of Conduct</h1>
coding_style.html:4:<h1>Coding Style</h1>
compile_debs.html:4:<h2>How Do I Compile The .debs From Source?</h2>
compile_debs.html:53:<h2>Debug Enabling your debs</h2>
compile_debs.html:73:<h2>Compiling debs from fresh GIT Clones</h2>
compile_debs.html:85:<h2>Compiling Bleeding Edge</h2>
configure_qmail_to_deliver_to_citadel.html:4:<h3>Using QMail as a frontend MTA to Citadel</h3>
configuring_postfix_to_validate_email_addresses_against_a_citadel_server.html:103:<h4>now the non match case:</h4>
configuring_postfix_to_validate_email_addresses_against_a_citadel_server.html:124:<h4>Troubleshooting</h4>
configuring_postfix_to_validate_email_addresses_against_a_citadel_server.html:153:<h2>Sample main.cf</h2>
configuring_postfix_to_validate_email_addresses_against_a_citadel_server.html:239:<h3>Integrating with RSpamD</h3>
configuring_postfix_to_validate_email_addresses_against_a_citadel_server.html:4:<h1>Configuring Postfix to validate email addresses against a Citadel server</h1>
configuring_postfix_to_validate_email_addresses_against_a_citadel_server.html:77:<h3>Use another mail account to verify that it's working</h3>
configuring_postfix_to_validate_email_addresses_against_a_citadel_server.html:79:<h4>Sending mail to an existing user should look like this:</h4>
configuring_postfix_to_validate_email_addresses_against_a_citadel_server.html:91:<h4>if you view citadel logging:</h4>
connection_broken_smtp.html:4:<h1> Why does the message "Connection broken during SMTP conversation" appear in the SMTP queue listing? </h1>
create_subroom.html:4:<h2>How do I create a sub-room?</h2>
credits_and_license.html:4:<h1>Credits and License</h1>
credits_and_license.html:6:<h2>Citadel: an open source messaging and collaboration platform</h2>
ctdlaidemessage.html:15:<h1>DESCRIPTION</h1>
ctdlaidemessage.html:20:<h1>PARAMETERS</h1>
ctdlaidemessage.html:28:<h1>SEE ALSO</h1>
ctdlaidemessage.html:30:<h1>HISTORY<h2>
ctdlaidemessage.html:4:<h1>CtdlAideMessage</h1>
ctdlaidemessage.html:8:<h1>SYNOPSIS</h1>
ctdlgetfloor.html:14:<h1>DESCRIPTION</h1>
ctdlgetfloor.html:18:<h1>PARAMETERS</h1>
ctdlgetfloor.html:27:<h1>RETURNS</h1>
ctdlgetfloor.html:33:<h1>SEE ALSO</h1>
ctdlgetfloor.html:35:<h1>HISTORY<h2>
ctdlgetfloor.html:4:<h1>CtdlGetFloor</h1>
ctdlgetfloor.html:8:<h1>SYNOPSIS</h1>
ctdlgetsysconfig.html:14:<h1>DESCRIPTION</h1>
ctdlgetsysconfig.html:20:<h1>PARAMETERS</h1>
ctdlgetsysconfig.html:29:<h1>RETURNS</h1>
ctdlgetsysconfig.html:33:<h1>SEE ALSO</h1>
ctdlgetsysconfig.html:35:<h1>HISTORY<h2>
ctdlgetsysconfig.html:4:<h1>CtdlGetSysConfig</h1>
ctdlgetsysconfig.html:8:<h1>SYNOPSIS</h1>
ctdlputsysconfig.html:14:<h1>DESCRIPTION</h1>
ctdlputsysconfig.html:20:<h1>PARAMETERS</h1>
ctdlputsysconfig.html:29:<h1>RETURNS</h1>
ctdlputsysconfig.html:31:<h1>SEE ALSO</h1>
ctdlputsysconfig.html:33:<h1>HISTORY<h2>
ctdlputsysconfig.html:4:<h1>CtdlPutSysConfig</h1>
ctdlputsysconfig.html:8:<h1>SYNOPSIS</h1>
customize_webcit.html:105:<h3>Using jshint for javascript syntax checking</h3>
customize_webcit.html:20:<h2>Wording / Translating</h2>
customize_webcit.html:22:<h4>technical details</h4>
customize_webcit.html:30:<h4>How to participate</h4>
customize_webcit.html:39:<h4>Using Launchpad</h4>
customize_webcit.html:4:<h1>Customizing WebCit</h1>
customize_webcit.html:53:<h4>External Translation tools</h4>
customize_webcit.html:6:<h2>Look and Feel</h2>
customize_webcit.html:72:<h4>Hints about some strings</h4>
customize_webcit.html:77:<h4>Fuzzy translations</h4>
customize_webcit.html:91:<h4>test-driving your translation</h4>
deferred_processing.html:12:<h2>Data model</h2>
deferred_processing.html:30:<h2>Synchronous operations</h2>
deferred_processing.html:4:<h1>How deferred processing works in Citadel</h1>
deferred_processing.html:51:<h2> Asynchronous operations (or, what happens during a purger run) </h2>
determine_ezinstall_or_debs.html:4:<h2>How do I determine which installation method was used for my system?</h2>
developer.html:4:<h2>Citadel Developer Information</h2>
dictionary.html:4:<h1>Dictionary</h1>
disk_space.html:4:<h1> Why doesn't deleting messages free up disk space? </h1>
documentation.html:24:<h2>man pages for commands</h2>
documentation.html:34:<h2>Developer documentation</h2>
documentation.html:3:<h1>Documentation</h1>
documentation.html:4:<h2>General</h2>
documentation.html:55:<h2>Featured projects</h2>
documentation.html:59:<h2>WebCit</h2>
does_citadel_have.html:13:<h2>When using the Debian packages</h2>
does_citadel_have.html:22:<h2>When using 'alternatives'</h2>
does_citadel_have.html:35:<h2>Or the brute force method...</h2>
does_citadel_have.html:4:<h1>Does Citadel have a <tt>/usr/sbin/sendmail</tt> replacement, so that I can send mail out from shell scripts?</h1>
does_citadel_have.html:50:<h2>Sample shell script using citmail</h2>
does_citadel_have.html:70:<h2>Using MSMTP</h2>
does_citadel_have.html:89:<h2>Email</h2>
does_citadel_have.html:8:<h2>When using Easy Install</h2>
does_citadel_have.html:96:<h2>Generating test messages</h2>
download.html:14:<h2 style="text-align:center">Easy Install (recommended)</h2>
download.html:30:<h2 style="text-align:center">Download the source code</h2>
download.html:42:<h2 style="text-align:center">Packages</h2>
download.html:5:<h1>Downloading Citadel</h1>
dspam.html:4:<h1>Citadel DKIM/Domainkey signature HowTo </h1>
easyinstall_force_reinstall.html:4:<h1>How can I force the Easy Install system to reinstall the programs?</h1>
easyinstall.html:14:<h2>Who should use this</h2>
easyinstall.html:20:<h2>Prerequisites</h2>
easyinstall.html:31:<h2>To get started...</h2>
easyinstall.html:4:<h1>Easy Install instructions</h1>
easyinstall.html:67:<h2>After Installation</h2>
edit_config_the_hard_way.html:4:<h3>Changing your citserver config the hard way</h3>
error_creating_new_user.html:4:<h1>An error occurs when an administrator attempts to create a new user</h1>
escapers.html:20:<h4>Characters escaped</h4>
escapers.html:32:<h3>H - HTML Encoding with linebreaks</h3>
escapers.html:46:<h3>J - Ecma Script / JSON escaping</h3>
escapers.html:4:<h2>WebCit Template Escaper functions</h2>
escapers.html:61:<h3>K - Ecma + HTML escaping</h3>
escapers.html:68:<h3>U - URL-Escaping</h3>
escapers.html:83:<h4>Characters not escaped:</h4>
escapers.html:9:<h3>X - HTML Encoding</h3>
example1.html:4:<h2>Example of a customized room view</h2>
faq.html:103:<h2>Spam filtering</h2>
faq.html:115:<h2>System Administration</h2>
faq.html:137:<h2>Troubleshooting</h2>
faq.html:28:<h2>Getting your favorite client software working</h2>
faq.html:3:<h1>FAQ / Knowledge Base</h1>
faq.html:45:<h2>General Questions</h2>
faq.html:4:<h2>Everyday Use</h2>
faq.html:66:<h2>Installation</h2>
faq.html:95:<h2>Mastering your OS</h2>
file_layout.html:16:<h2>Consolidated layout (Easy Install or Docker installations)</h2>
file_layout.html:25:<h2>LFHS layout (.deb or .rpm packages)</h2>
file_layout.html:4:<h1>File layouts for the Citadel system</h1>
forgotpassword.html:4:<h1>I forgot my administrator password.  What can I do?</h1>
gdb.html:134:<h3>Using Valgrind</h3>
gdb.html:146:<h3>Profiling</h3>
gdb.html:148:<h4>Prerequisites</h4>
gdb.html:169:<h4>Measuring</h4>
gdb.html:20:<h3>Which kind of binaries produce useful output?</h3>
gdb.html:40:<h3>How do I make my system produce core dump files?</h3>
gdb.html:4:<h1>Debugging</h1>
gdb.html:60:<h3> Analyzing Core files </h3>
gdb.html:92:<h3>Running Programs in GDB</h3>
general_configuring.html:11:<h3>What is StartTLS/SSL?</h3>
general_configuring.html:18:<h3>What do you mean by Relaying vs. Local delivery? </h3>
general_configuring.html:25:<h3>SMTP</h3>
general_configuring.html:45:<h3>POP3</h3>
general_configuring.html:4:<h2>General Client Configuration Recomendations</h2>
general_configuring.html:56:<h3>IMAP</h3>
general_configuring.html:68:<h3>Binding a service to more than one port</h3>
gethash.html:14:<h1>DESCRIPTION</h1>
gethash.html:18:<h1>PARAMETERS</h1>
gethash.html:29:<h1>RETURNS</h1>
gethash.html:34:<h1>SEE ALSO</h1>
gethash.html:36:<h1>HISTORY<h2>
gethash.html:4:<h1>GetHash</h1>
gethash.html:8:<h1>SYNOPSIS</h1>
get_sample_messages.html:13:<h3>On the way in with tcpdump</h3>
get_sample_messages.html:4:<h1>Exporting a message for a bug report</h1>
get_sample_messages.html:6:<h3>Via IMAP and Thunberbird</h3>
getting_mails_into_citadel.html:20:<h4> Sending </h4>
getting_mails_into_citadel.html:31:<h3> Scenario #2: fetching email from other servers </h3>
getting_mails_into_citadel.html:36:<h4>Retrieving mail</h4>
getting_mails_into_citadel.html:40:<h4>Sending</h4>
getting_mails_into_citadel.html:4:<h2>Getting email into Citadel; Sending email to the outside world</h2>
getting_mails_into_citadel.html:6:<h3> Scenario #1: Citadel as the primary mail server </h3>
getting_mails_into_citadel.html:8:<h4> Receiving </h4>
global_sieve.html:4:<h1>Can I configure a site-wide Sieve script that runs on every incoming message, in addition to
groupdav_urls.html:4:<h1>How do I use Citadel's calendar, address book, etc. from KOrganizer (or other GroupDAV client)?</h1>
header.html:5:<html lang="en" dir="ltr" xmlns="http://www.w3.org/1999/xhtml">
hints_for_installing_citadel_on_mac_os.html:4:<h1>Hints for installing Citadel on Mac OS</h1>
how_can_i_batch_create_a_list_of_users_on_a_new_system.html:4:<h1> How can I "batch create" a list of users on a new system? </h1>
how_can_i_import_ldif_format_contacts_into_an_address_book_room.html:4:<h1>How can I import LDIF format contacts into an address book room?</h1>
how_do_i_access_room_content_without_logging_into_webcit.html:4:<h1> How do I Access Room Content Without Logging Into Webcit? </h1>
how_do_i_allow_citadel.html:4:<h1>How do I allow citadel users to login without my Unix/Linux system asking for a password?</h1>
how_do_i_automatically_forward_all_mail_to_a_remote_email_address_somewhere.html:4:<h1> How do I automatically forward all mail to a remote email address somewhere? </h1>
how_do_i_configure_email_aliases_for_a_user.html:4:<h1> How do I configure email aliases for a user? </h1>
how_do_i_create_a_public_mailbox_to_be_accessed_by_several_users.html:4:<h1> How Do I Create A Public Mailbox To Be Accessed By Several Users? </h1>
how_do_i_disable_sendmail_on_freebsd.html:4:<h1>How do i disable the system Sendmail on FreeBSD?</h1>
how_do_i_disable_the_main_menu_in_the_text_mode_client.html:4:<h1> How Do I Disable The "Main Menu" In The Text-Mode Client? </h1>
how_do_i_enable_ansi_color_support.html:4:<h1> How do I enable "ANSI color" support? </h1>
how_do_i_expire_messages.html:4:<h2>How do I expire messages</h2>
how_do_i_get_citadel.html:4:<h1>How do I get Citadel to answer telnet connections directly, without first requiring
how_do_i_move_citadel_to_another_host.html:4:<h3>How do I move my Citadel installation to another machine?</h3>
how_do_i_post_messages_via_smtp_mail_into_a_room.html:4:<h1> How do I Post Messages Via SMTP Mail Into A Room? </h1>
how_do_i_retrieve.html:20:<h4>FreePOPs</h4>
how_do_i_retrieve.html:26:<h4>RSS aggregation</h4>
how_do_i_retrieve.html:33:<h4>Citadel command line</h4>
how_do_i_retrieve.html:38:<h4>fetchmail</h4>
how_do_i_retrieve.html:4:<h1>How do I retrieve mail from remote servers/accounts and file that mail into Citadel?</h1>
how_do_i_retrieve.html:53:<h4>fetchmail & domainpop</h4>
how_do_i_retrieve.html:6:<h4>Webcit</h4>
how_do_i_uninstall_citadel.html:10:<h3>Easy Install</h3>
how_do_i_uninstall_citadel.html:21:<h3>Debian Packages</h3>
how_do_i_uninstall_citadel.html:4:<h1> How do I "uninstall" Citadel? </h1>
how_do_you_base_your_claims_that_citadel_is_powerful_and_scalable.html:4:<h1>How do you base your claims that Citadel is "powerful and scalable?"</h1>
how_may_i_improve.html:4:<h1>How may I improve performance by placing the databases and/or database logs on separate disk subsystems?</h1>
howto_have_different_recipientrooms_for_different_domains.html:4:<h3>How do I create two public email adrresses with same recipient but in different domains?</h3>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:103:<h3>What happened?</h3>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:13:<h2>Erase, or set aside, the existing key</h2>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:24:<h2>Generate a private key</h2>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:32:<h2>Generate a Certificate Signing Request based on that key</h2>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:4:<h1>How to install a certificate signed by a recognized Certificate Authority.</h1>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:50:<h3>Generate a self-signed certificate (if needed for temporary use)</h3>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:59:<h3>Install the signed certificate</h3>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:66:<h3>Using the key and certificate with WebCit</h3>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:76:<h2>Problems with Citadels autogenerated Certificates</h2>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:78:<h3>Citadel making it easy for you</h3>
how_to_install_a_certificate_signed_by_a_recognized_certificate_authority.html:84:<h3>Drawback under certain conditions</h3>
howto_login_first.html:4:<h3>What is the default Install Administrator Password / User?</h3>
i_can_t_compile_the_program._what_should_i_do.html:4:<h1>I can't compile the program. What should I do?</h1>
i_have_duplicate_mails_in_my_sent_items_folder._why.html:4:<h1>I have duplicate mails in my 'Sent Items' folder. Why?</h1>
i_installed_webcit.html:4:<h1>I installed WebCit but when I try to connect with my browser it doesn't log in.  Why?</h1>
i_like_squirrel_mail._how_do_i_run_it_on_top_of_citadel.html:4:<h1>I Like Squirrel Mail. How Do I Run It On Top Of Citadel?</h1>
i_m_having_trouble_with_the_external_editor_in_the_text_cit_client_for_ms_windows.html:4:<h1> I'm Having Trouble With The External Editor In The Text Cit Client For MS Windows. </h1>
index.html:14:      <h1>Powerful and flexible</h1>
index.html:15:      <h5 class="w3-padding-32">
index.html:35:      <h1>Packed with features</h1>
index.html:4:<header class="w3-container w3-blue w3-center" style="padding:50px">
index.html:59:      <h1>True open source</h1>
index.html:5:<h2>Meet the <b>Citadel</b> System.<br>Easy to install. Easy to use. 100% open source.  No compromises.</h2>
index.html:60:      <h5 class="w3-padding-32">
index.html:7:<h3>Email, collaboration, groupware, and content management -<br>up and running in minutes, on your own hardware or in the cloud.</h3>
installing_citadel_on_freebsd.html:4:<h1>Installing Citadel on FreeBSD</h1>
installing_citadel_on_rpm_based_distro.html:4:<h1> Install Citadel on RPM based distributions </h1>
instant_expunge.html:4:<h1> What is "instant expunge" and when should I use it? </h1>
intermediate_versions.html:4:<h1>Easy Install gave me version XXX but the download site only shows an earlier version
invitation_from_facebook.html:4:<h2>How do I add an Invitation from Facebook to my personal Calendar?</h2>
is_citadel_web_based_or_text_based.html:4:<h1>Is Citadel web-based or text-based?</h1>
is_it_necessary_to_use_the_citmail_mda.html:4:<h1> Is it necessary to use the 'citmail' MDA? </h1>
i_want_to_automate.html:23:<h2>Example: Cleaning up the Citadel User List / Global Address Book</h2>
i_want_to_automate.html:4:<h1>I want to automate certain tasks by scripting the Citadel server. How would I do that?</h1>
i_want_to_automate.html:74:<h2>Example: Cleaning an overpopulated Mailbox (Trash, spam... )</h2>
i_want_to_be_a_whitehead.html:4:<h1>Troubleshooting outbound email issues</h1>
jabber.html:4:<h1>Configuring a Jabber client to access Citadel</h1>
journaling.html:127:<h2>Disclaimer</h2>
journaling.html:21:<h2>Technical overview of Citadel journaling</h2>
journaling.html:4:<h1>Message Journaling with the Citadel System</h1>
journaling.html:50:<h2>Additional resource utilization</h2>
journaling.html:5:<h2>A technical guide</h2>
journaling.html:61:<h2>Where should I send the journalized messages?</h2>
journaling.html:6:<h3>Copyright ©2006 by the Citadel development team.</h3>
journaling.html:87:<h2>How to configure journaling</h2>
journaling.html:8:<h2>Introduction</h2>
ldap_deprecated.html:26:<h2>Important Note</h2>
ldap_deprecated.html:4:<h1>How do I configure LDAP authentication?</h1>
libcitadel_api.html:4:<h2>Libcitadel API</h2>
libical.html:14:<h2>Mailing Lists</h2>
libical.html:22:<h2> Who uses libical? </h2>
libical.html:40:<h2>Download libical</h2>
libical.html:4:<h2>libical</h2>
libs.html:4:<h1>Libraries</h1>
logging.html:4:<h4>Logging</h4>
logging.html:6:<h5>Printing to the log file or console</h5>
login.html:16:<h3> Login screen structure </h3>
login.html:21:<html>
login.html:4:<h3>Login screen customization</h3>
loglevel.html:14:<h1>DESCRIPTION</h1>
loglevel.html:18:<h1>VALUES</h1>
loglevel.html:34:<h1>SEE ALSO</h1>
loglevel.html:40:<h1>HISTORY<h2>
loglevel.html:4:<h1>LogLevel</h1>
loglevel.html:8:<h1>SYNOPSIS</h1>
mail_terms.html:15:<h2>Smart Hosts</h2>
mail_terms.html:24:<h2>RBL Hosts</h2>
mail_terms.html:29:<h2>SpamAssassin Hosts</h2>
mail_terms.html:35:<h2>Masqueradable Domains</h2>
mail_terms.html:4:<h1>Generic terms to email servers</h1>
mail_terms.html:9:<h2>Local Host Aliases</h2>
manpages.html:4:<h1>Citadel Tools Commandline Options and Usage</h1>
maximum_store_size.html:4:<h1>What is the maximum size of a Citadel message store?</h1>
messages.html:29:<h4>Iterator MAIL:SUMM:MSGS</h4>
messages.html:35:<h4>Mail Context</h4>
messages.html:37:<h4>Iterators</h4>
messages.html:49:<h4>Tokens</h4>
messages.html:4:<h2>Message templating</h2>
messages.html:75:<h4>Conditionals</h4>
messages.html:91:<h3>MIME Attachment Context</h3>
messages.html:93:<h4>Tokens</h4>
migrating_ldap_into_citadel.html:4:<h2>VCards and Citadel</h2>
migrating_ldap_into_citadel.html:6:<h3> Migrating LDAP data and Outlook VCards to citadel</h3>
migrating_ldap_into_citadel.html:95:<h3>Exporting Citadel's Global Address Book to a Outlook contact file(.pst)</h3>
migrating_mail_into_citadel.html:4:<h1> How do I move all of my mail from a legacy mail server to Citadel? </h1>
mobile.html:4:<h1>How do I support mobile devices and push e-mail with the Citadel system?</h1>
modules.html:4:<h3>Creating Modules</h3>
modules.html:6:<h4>What is a Module</h4>
monitoring.html:4:<h1> Monitoring the Citadel system </h1>
msadsso.html:11:<h2>Installing Active Directory</h2>
msadsso.html:37:<h2> Creating the query user </h2>
msadsso.html:4:<h1> Single sign-on with Citadel and Microsoft Active Directory </h1>
msadsso.html:62:<h2>Configuring Citadel</h2>
msadsso.html:86:<h3>Important Note</h3>
ms_outlook.html:4:<h1>Can I connect to Citadel with Microsoft Outlook?</h1>
mutt_runs_slow_why.html:4:<h1>"mutt" runs slow!  Why?</h1>
my_calendar_entries_in_kmail_kontact_show_different_hours_than_webcit.html:4:<h1>My Calendar entries in KMail, Kontact, etc. show different hours than Webcit. </h1>
netconfig.html:13:<h3>POP3 Aggregator</h3>
netconfig.html:17:<h3>RSS Aggregator<h2>
netconfig.html:22:<h3>Mailing list components<h2>
netconfig.html:4:<h2>Networking Configurations</h2>
net.html:141:<h3> NetCat </h3>
net.html:151:<h4>Netcat as Server</h4>
net.html:177:<h4> Netcat as Client</h4>
net.html:202:<h3>Hostname lookup</h3>
net.html:27:<h3>route</h3>
net.html:39:<h3>netstat</h3>
net.html:4:<h1>Networking</h1>
net.html:86:<h3>telnet</h3>
net.html:9:<h3>ifconfig</h3>
net_sniff.html:10:<h3>tcpdump</h3>
net_sniff.html:13:<h4> Ommitting Nameserver Lookup </h4>
net_sniff.html:20:<h4> listening on a specific interface </h4>
net_sniff.html:28:<h4> Create files to explore them later </h4>
net_sniff.html:34:<h4> Reducing Packages later </h4>
net_sniff.html:39:<h4> filtering </h4>
net_sniff.html:4:<h1>Exploring the communication from your Citadel server</h1>
net_sniff.html:51:<h3> NGrep </h3>
net_sniff.html:60:<h3> Wireshark </h3>
net_sniff.html:65:<h3>etherape</h3>
net_sniff.html:67:<h3>NTop</h3>
net_sniff.html:71:<h3>Sniffing several simultaneous Connections</h3>
newstrbufplain.html:14:<h1>DESCRIPTION</h1>
newstrbufplain.html:18:<h1>PARAMETERS</h1>
newstrbufplain.html:27:<h1>RETURNS</h1>
newstrbufplain.html:32:<h1>SEE ALSO</h1>
newstrbufplain.html:34:<h1>HISTORY<h2>
newstrbufplain.html:4:<h1>NewStrBufPlain</h1>
newstrbufplain.html:8:<h1>SYNOPSIS</h1>
no_backups.html:4:<h1>[ My server crashed | disk failure | other catastrophe ] and I don't have a backup of my Citadel; how can I
notification_api.html:10:<h3>URL Scheme in admin interface</h3>
notification_api.html:42:<h3>Per User Setting</h3>
notification_api.html:4:<h2>Notification API<h3>
openid.html:17:<h2> Where can I get an OpenID? </h2>
openid.html:21:<h2>Logging in to Citadel using OpenID</h2>
openid.html:23:<h3>New users</h3>
openid.html:38:<h3>Existing users</h3>
openid.html:4:<h1>OpenID</h1>
openid.html:50:<h2>User names and passwords</h2>
openid.html:66:<h2>Caveats</h2>
openid.html:8:<h2>Citadel is using OpenID</h2>
outbound_mail.html:4:<h1>Outbound mail is not being delivered and/or is stuck in the queue</h1>
out_of_lock_entries.html:4:<h1>citserver fails to start, and an error message like "DB: Lock table is out of available object entries" appears in the log</h1>
password_strength.html:4:<h1> Why doesn't Citadel have the ability to enforce password strength? </h1>
postmaster_and_co.html:4:<h3>Where does Citadel put postmaster messages? How can I change that?</h3>
preferences.html:16:<h4>PREF:ZONE</h4>
preferences.html:18:<h4> COND:PREF </h4>
preferences.html:4:<h3> Preferences </h3>
ps.html:15:<h3> pstree </h3>
ps.html:4:<h1> Checking what services are running </h1>
ps.html:53:<h3> top / prstat </h3>
ps.html:6:<h3> ps </h3>
qpsmtpd.html:170:<h2>Configuration</h2>
qpsmtpd.html:172:<h3>Citadel Changes</h3>
qpsmtpd.html:179:<h3>qpsmtpd Configuration</h3>
qpsmtpd.html:22:<h2>Installation</h2>
qpsmtpd.html:4:<h1> Fighting spam with qpsmtpd </h1>
rdbms_store_layer.html:13:<h2>Accessing your email</h2>
rdbms_store_layer.html:23:<h2> Backing up your data </h2>
rdbms_store_layer.html:33:<h3>How Citadel stores your data</h3>
rdbms_store_layer.html:4:<h1>Why Don't You Build A Store Driver For MySQL, Postgres, Oracle, etc.?</h1>
recover.html:10:<h2>Stop spam from being sent</h2>
recover.html:124:<h2>getting back to normal business</h2>
recover.html:23:<h2>Stop spam from arriving</h2>
recover.html:35:<h2>Analyze the Situation</h2>
recover.html:48:<h2>Clearing the Situation</h2>
recover.html:4:<h1>How do I recover from a spam attack?</h1>
recover.html:61:<h2>Clearing the situation - without webcit</h2>
relay.html:4:<h2> Configuring Relaying </h2>
richedit.html:22:<h2> Troubleshooting </h2>
richedit.html:4:<h2>Rich text editor customization</h2>
room.html:16:<h3> Room screen structure </h3>
room.html:19:<html>
room.html:4:<h2> Room screen customization </h2>
room.html:50:<h4> Banner detail </h4>
room.html:53:<html>
rooms.html:4:<h3>Room Related</h3>
rooms.html:51:<h4>Tokens</h4>
rooms.html:62:<h4>Iterators</h4>
rooms.html:9:<h4>Conditionals</h4>
rss_aggregation.html:4:<h1> How do I aggregate RSS feeds into rooms? </h1>
screenshots.html:12:<h2>WebCit Calendar</h2>
screenshots.html:17:<h2>WebCit Email</h2>
screenshots.html:22:<h2>WebCit Rich Edit</h2>
screenshots.html:28:<h2>WebCit Summary</h2>
screenshots.html:33:<h2>WebCit Task List</h2>
screenshots.html:39:<h2>Sticky notes</h2>
screenshots.html:45:<h2>KDE Kontact</h2>
screenshots.html:50:<h2>Kontact</h2>
screenshots.html:55:<h2>Evolution</h2>
screenshots.html:5:<h2>WebCit Public Folder</h2>
screenshots.html:60:<h2>Microsoft Outlook</h2>
screenshots.html:66:<h2>WebCit System Adminstration</h2>
screenshots.html:72:<h2>Citadel Text Rooms</h2>
screenshots.html:79:<h2>Citadel Text Message</h2>
sendcommand.html:14:<h1>DESCRIPTION</h1>
sendcommand.html:20:<h1>OPTIONS</h1>
sendcommand.html:29:<h1>DEFAULTS</h1>
sendcommand.html:34:<h1>CAVEATS</h1>
sendcommand.html:40:<h1>HISTORY</h1>
sendcommand.html:4:<h1>sendcommand</h1>
sendcommand.html:8:<h1>SYNOPSIS</h1>
servcfg.html:14:<h4>COND:SERVCFG</h4>
servcfg.html:4:<h3>SERV:CFG</h3>
server_api.html:4:<h2>Citadel Server API</h2>
setup_crashes_right.html:4:<h1>setup crashes right after asking for the port number. How can I fix this?</h1>
setup.html:14:<h1>DESCRIPTION</h1>
setup.html:19:<h1>OPTIONS</h1>
setup.html:46:<h2>HISTORY</h2>
setup.html:4:<h1>setup</h1>
setup.html:8:<h1>SYNOPSIS</h1>
shared_account.html:4:<h2>How do I best share Inboxes between several users?</h2>
sieve.html:13:<h3>Create / add a rule</h3>
sieve.html:16:<h3>Auto Reply Messages</h3>
sieve.html:4:<h2> How do I .... with Citadels Serverside Mail Filtering? </h2>
sieve.html:5:<h3>Enable=</h3>
sourcecode.html:17:<h2>libcitadel<h3>
sourcecode.html:22:<h3>StrBuf</h3>
sourcecode.html:39:<h4>How?</h4>
sourcecode.html:4:<h1>Citadel Source Code Documentation</h1>
sourcecode.html:6:<h2>libical</h2>
source.html:125:<h1>Third-party contributions</a></h1>
source.html:154:<h1>Source code repository</a></h1>
source.html:15:<h1>Required dependencies</h1>
source.html:36:<h1>libcitadel</h1>
source.html:50:<h1>Citadel Server</h1>
source.html:5:<h1>Source code</h1>
source.html:62:<h1>WebCit</a></h1>
source.html:77:<h1>Text mode client</h1>
source.html:93:<h1>Included Third Party Dependencies</a></h1>
spamassassin.html:41:<h2>Configuring a per user Spam folder</h2>
spamassassin.html:4:<h1>SpamAssassin</h1>
standby_server.html:4:<h1>How can I set up a "hot standby" Citadel server?</h1>
start.html:5:<h1> Documentation </h1>
strbufappendbufplain.html:14:<h1>DESCRIPTION</h1>
strbufappendbufplain.html:19:<h1>PARAMETERS</h1>
strbufappendbufplain.html:30:<h1>RETURNS</h1>
strbufappendbufplain.html:37:<h1>SEE ALSO</h1>
strbufappendbufplain.html:39:<h1>HISTORY<h2>
strbufappendbufplain.html:4:<h1>StrBufAppendBufPlain</h1>
strbufappendbufplain.html:8:<h1>SYNOPSIS</h1>
strlength.html:14:<h1>DESCRIPTION</h1>
strlength.html:18:<h1>PARAMETERS</h1>
strlength.html:26:<h1>RETURNS</h1>
strlength.html:33:<h1>SEE ALSO</h1>
strlength.html:35:<h1>HISTORY<h2>
strlength.html:4:<h1>StrLength</h1>
strlength.html:8:<h1>SYNOPSIS</h1>
substlist.html:5:<h4>COND:SUBST</h4>
support.html:28:      <h1>Citadel Support</h1>
support.html:52:      <h1>Citadel Development</h1>
support.html:53:      <h5 class="w3-padding-32">
support.html:7:      <h1>Support options for Citadel</h1>
support.html:8:      <h5 class="w3-padding-32">
system_administration_manual.html:102:<h3>Bypassing the <tt>login:</tt> prompt</h3>
system_administration_manual.html:1155:<h2>Configuring Citadel for Internet e-mail</h2>
system_administration_manual.html:1157:<h3>Introduction</h3>
system_administration_manual.html:1184:<h3>Basic site configuration</h3>
system_administration_manual.html:1289:<h3> Enabling the Internet mail protocols </h3>
system_administration_manual.html:1411:<h3> Using Citadel in conjunction with another MTA </h3>
system_administration_manual.html:143:<h3>Compiling the programs</h3>
system_administration_manual.html:1468:<h3> Hosting an Internet mailing list </h3>
system_administration_manual.html:1569:<h2> Database maintenance </h2>
system_administration_manual.html:1572:<h3> Introduction </h3>
system_administration_manual.html:1600:<h3> Backing up your Citadel database </h3>
system_administration_manual.html:1612:<h5> Strategy #1: Standard backup </h5>
system_administration_manual.html:1636:<h5> Strategy #2: "Hot" backup </h5>
system_administration_manual.html:1675:<h3> Database repair </h3>
system_administration_manual.html:16:<h3>Installation Overview</h3>
system_administration_manual.html:1700:<h3> Importing/Exporting your Citadel database </h3>
system_administration_manual.html:1778:<h2> Cryptography support (TLS/SSL) </h2>
system_administration_manual.html:1781:<h3> Overview </h3>
system_administration_manual.html:1807:<h3> Generating and installing a Trusted Certificate </h3>
system_administration_manual.html:1848:<h2> LDAP (Directory) Support </h2>
system_administration_manual.html:1853:<h3> Introduction </h3>
system_administration_manual.html:1867:<h3> Preparing your LDAP server for Citadel connections </h3>
system_administration_manual.html:1876:<h3> Configuring the LDAP Connector for Citadel </h3>
system_administration_manual.html:188:<h3>Upgrading</h3>
system_administration_manual.html:1916:<h2> Utilities </h2>
system_administration_manual.html:1919:<h3> Overview </h3>
system_administration_manual.html:1933:<h3>sendcommand</h3>
system_administration_manual.html:201:<h3>The "citadel.rc" file</h3>
system_administration_manual.html:216:<h3>Using an external editor for message composition</h3>
system_administration_manual.html:235:<h3>Printing messages</h3>
system_administration_manual.html:253:<h3>URL viewing</h3>
system_administration_manual.html:265:<h3>Setup and login</h3>
system_administration_manual.html:315:<h3> Configuring your host system to start the service </h3>
system_administration_manual.html:383:<h3> Logging in for the first time </h3>
system_administration_manual.html:391:<h3> Welcoming new users </h3>
system_administration_manual.html:406:<h3> Troubleshooting and getting help </h3>
system_administration_manual.html:439:<h2>System Administration</h2>
system_administration_manual.html:441:<h3> Overview </h3>
system_administration_manual.html:463:<h3>Admin commands</h3>
system_administration_manual.html:4:<h2>Manual installation of Citadel using source code and the command line client</h2>
system_administration_manual.html:519:<h3> Editing rooms </h3>
system_administration_manual.html:51:<h3>Other pieces which complete the Citadel system:</h3>
system_administration_manual.html:62:<h3>Everything in its place...</h3>
system_administration_manual.html:698:<h3> File directories </h3>
system_administration_manual.html:6:<h3>Intended audience</h3>
system_administration_manual.html:714:<h3>Creating and editing user accounts</h3>
system_administration_manual.html:73:<h3> Creating a system account for Citadel </h3>
system_administration_manual.html:803:<h3>Deleting and moving messages</h3>
system_administration_manual.html:816:<h3> Site configuration </h3>
systemd.html:24:<h2>Second instance</h2>
systemd.html:35:<h2>Additional resources</h2>
systemd.html:4:<h1>Citadel and systemd</h1>
systemd.html:9:<h2>systemd configuration</h2>
terminology.html:4:<h1> I don't understand the rooms/floors thing.  What's with all the weird terminology? </h1>
the_client_crashes_when_i_hit_enter_message._how_can_i_fix_this.html:4:<h1>The text mode client crashes when I hit 'Enter message.' How can I fix this?</h1>
the_client_locks.html:4:<h1> The client locks up when I attempt to Quote or Print. How can this be fixed? </h1>
threads.html:16:<h5>CtdlThreadCreate()</h5>
threads.html:4:<h4>Threads</h4>
tracking_citadel.html:15:<h3> Editing email aliases </h3>
tracking_citadel.html:19:<h3> Aide editing/creating users </h3>
tracking_citadel.html:22:<h3> System wide Email aliases </h3>
tracking_citadel.html:25:<h3> Checking DNS </h3>
tracking_citadel.html:28:<h3> Rebuilding the Email address mapping database </h3>
tracking_citadel.html:38:<h3> Testing host based authentication </h3>
tracking_citadel.html:4:<h3> How do i track down or follow mesages or users? </h3>
tracking_citadel.html:5:<h3> Checking whether a mail is deliverable </h3>
tracking_citadel.html:71:<hit CTRL+C to stop it>
training_sa.html:3:<h1> How can I plug sa-learn into Citadel to 'train' SpamAssassin? </h1>
userlist.html:32:<h4>User data</h4>
userlist.html:4:<h3>Browsing / Editing Users</h3>
userlist.html:50:<h3>Conditionals</h3>
userlist.html:52:<h4>COND:USERNAME</h4>
userlist.html:59:<h4>COND:USERACCESS</h4>
userlist.html:68:<h4>COND:USERLIST:FLAG:USE_INTERNET</h4>
userlist.html:6:<h4>USERLIST iterator</h4>
using_your_citadel_calendar_and_contacts_in_thunderbird.html:4:<h1>Using your Citadel calendar and contacts in Thunderbird</h1>
viewhack.html:41:<h4>Webcit room Renderers</h4>
viewhack.html:4:<h3>Inspecting internal information using Webcit</h3>
viewhack.html:66:<h4>Hacking it by self composing URLs</h4>
viewhack.html:9:<h4>Special Rooms / Aliases</h4>
webcit_appears.html:4:<h1>WebCit appears to have gone haywire - markup is scattered all over the screen?</h1>
webcit_browser.html:4:<h1>Recommended browsers for Webcit</h1>
webcit_built_successfull_with_locale_support_but_it_s_nailed_to_one.html:4:<h1>Webcit built successfully with locale support, but it's nailed to one.</h1>
webcit_doesnt_open_the.addressbook_popup.html:4:<h2>Webcit doesn't open the addressbook popup</h2>
webcit_file_icons.html:4:<h2>How do I make WebCit use my prefered freedesktop.org Icontheme? </h2>
webcit.html:10:<h2>Marking</h2>
webcit.html:12:<h3>Mark all emails in my Mailbox</h3>
webcit.html:16:<h3> Mark the upper most 10 emails </h3>
webcit.html:20:<h3>Mark Various Mails</h3>
webcit.html:24:<h2>Moving, etc.</h2>
webcit.html:28:<h3>Move to some other folder</h3>
webcit.html:33:<h3>Delete</h3>
webcit.html:37:<h2> How do I create a Subroom of a Room?</h2>
webcit.html:4:<h1>How do I ... in WebCit?</h1>
webcit_unable_to_connect.html:4:<h1>When connecting to WebCit, the message "This program was unable to connect or stay
webcit_users_appear_with_the_wrong_hostname_in_the_whois_online_page.html:4:<h1>WebCit users appear with the wrong Hostname in the "who is online" page.</h1>
webcit_without_citadel.html:4:<h1> Can I use WebCit with a non-Citadel IMAP service? </h1>
what_are_the_memory_requirements.html:4:<h1>What are the memory requirements?</h1>
what_if_someone_wants_to_make_a_room_into_a_mailing_list_can_we_do_that.html:4:<h1> How do I create a mailing list or distribution list? </h1>
what_is_the_best_way_to_backup_my_citadel_installation.html:4:<h1>What is the best way to backup my Citadel installation?</h1>
what_is_the_difference_between_citadel_and_citadel_ux.html:4:<h1> What is the difference between Citadel and Citadel-UX? </h1>
what_operating_systems_are_supported.html:4:<h1> What operating systems are supported? </h1>
what_source_code_license_do_you_use.html:4:<h1>What source code license do you use?</h1>
what_s_wrong.html:4:<h1>What's wrong when I get the message: Connection refused: can't connect to 127.0.0.1.citadel?</h1>
what_url_s_do_i_use.html:12:<h2>Caveats / Warnings</h2>
what_url_s_do_i_use.html:20:<h2>Accessing your account's main Calendar room</h2>
what_url_s_do_i_use.html:43:<h2> Accessing other rooms that have a Calendar View </h2>
what_url_s_do_i_use.html:4:<h1>What URL's do I use for 'webcal' publish/subscribe, with Mozilla Lightning/Sunbird, Apple iCal, etc.?</h1>
what_url_s_do_i_use.html:52:<h2> Free / Busy </h2>
what_url_s_do_i_use.html:64:<h2>Testing</h2>
what_url_s_do_i_use.html:6:<h2>The Basics</h2>
what_url_s_do_i_use.html:70:<h2>Application specific hints</h2>
what_url_s_do_i_use.html:72:<h3> Subscribing in read/write mode with Apple iCal/Calendar </h3>
what_url_s_do_i_use.html:88:<h2> List of known working applications </h2>
what_url_s_do_i_use.html:90:<h3> Apple OS X </h3>
what_url_s_do_i_use.html:97:<h3> Android </h3>
when_i_send.html:4:<h1> When I send a message using Thunderbird, it hangs on "Copying message to Sent folder" </h1>
when_i_telnet.html:4:<h1>When I telnet to the Citadel port I get something like "200 mysystemname Citadel server ready." Why?</h1>
where_is_home_base_for_citadel.html:4:<h1> Where is 'home base' for Citadel? </h1>
wholist.html:4:<h4>WHOLIST</h4>
why_don_t_i_see.html:3:<h1> Why don't I see my public folders when I connect with the "Evolution" client?</h1>
zlib.html:4:<h1>citserver fails to start, saying "Database contains compressed data, but this citserver

One of the first things that's being done is to convert all the sources to clean markdown.This was automated, but came out pretty good..

I've evaluated some static site generators, and have considered rolling our own.. but markdown (with tags) is the order of the day for that kind of thing..so anyway..

I think a good division is into these three spheres:

* User manual (Everything from how to change your password, to setting up forwarding and other inbox rules)

* Admin Manual (And all that it entails)

* Developer .. etc.

Even so, there is also the code documentation itself, which I generated with Doxygen, although nobody has seen it yet.

Also under consideration are the creating of of meaningful, SEO optimized urls like

siteroot/user-manual/how-do-i-do-such-and-such.html

The existing paradigm is that most things are faq entries.. so a rewrite of this order is going to be massive upheaval..I have already collected every possible existing URL so we can add redirects for them with nginx.

So, in the short term, I'll be doing the updates on the main website as is.. and probably setting up a new vhost for the experimental documentation stuff.

I've considered may other FOSS documentation websites, thinking what I liked & what I didn't.  I don't like "cramped" javascripty popouts and things like that..

PLAIN HTML.. easily found, easy to cache, super fast, easy to print etc..

Navigation is always important, and a clean topical table of contents.. at some point, I'll start posting my notes here, but feel free to make suggestions anytime.

Spinx or Solr may be options down the road, but we still have a long way to go before that..

If we had better search engine visibility and navigation, they would probably be unnecessary..

Mon Nov 16 2020 12:35:30 PM EST from platonov Subject: Documentation Navigators and information organization

This is a response to the citadel support room thread:

Re: MIGR export/import for database recovery/upgrades/selective mods

Great to hear that. Actually, I had plenty of frustration in trying to find good info in Citadel docs and found that it takes WAY too much time to find things that could be found within minutes, if not seconds. Not that the info is not there, but you can't quite get to it and/or find it.

One of the things I found most valuable in any kind of writing, documentation or not, is the extensive TOC, pointing out every thing, be it some "small" issue or "large". Just because something is "small" does not mean it does not deserve to be found in table of contents. Otherwise, if it is THAT small that it "doesn't worth pointing it out", then why did you write it at all to begin with? Basically, all you have to do is to place the "small" things in less significant or noticeable places in TOC or on a deeper tree level.

Just by having the extensive TOC you increase the accessibility and locatability of info by orders of magnitude.

One other thing is local search engine. Why not use, for example, Solr search engine? You can index this entire collection and have every page indexed nearly instantly and have the REAL search engine results and not some quite unintuitive hack imitating the search engine functionality.

In fact, I can give the fully functional search engine code with php driven interface for indexing, search box and the rest of it and you'll have the entire documentation collection searchable in no time.

People underestimate the value and significance of information way too much and end up wasting orders of magnitudes in time, efforts and wasted energy, wasted for nothing.

One simple thing that can be done, and pretty fast, is creation of navigator page. Basically, the navigator page is a regular html page containing links to other places. You don't even have to have any actual information in the nav pages. All you need is links, like a tree structure of typical TOC. That nav page alone can be easily remembered, and, since it has the links to ALL the separate pages, all you need is that nav page to get to ANY info.

And if you have many small pages, each containing a short description of some item, topic, etc., then you create a nested, tree-like structured arrangement, where you do not include every small point in the main index of the navigator, but create a sub-toc.

 

Sun Nov 15 2020 17:37:25 EST from omatnet @ Uncensored Subject: Re: MIGR export/import for database recovery/upgrades/selective mods

Wow, that you so much! This is a great resource and should be on the Citadel website...! I can't believe I've been using Citadel for 8 years now, researching for info and learning to tweak it, and this is the first time I see such a good and comprehensive reference for using the 'sendcommand'

Thank you so much!!!

Sat Nov 14 2020 15:58:11 EST from platonov @ Uncensored Subject: Re: MIGR export/import for database recovery/upgrades/selective mods

Well, I can offer you a couple of key Citadel documents (see attachments here).

They are based on protocol and system_administration_manual. But they have been redone to include the extensive TOC and all sorts of formatting has been changed to make it all look the way I like to see things. Just unzip it and make sure css/main.css is present for the styles to work they way it was intended.

Protocol is actually that "good and detailed 'sendcommand' commands+parameters documentation".

So...

Sat Nov 14 2020 13:31:01 EST from omatnet @ Uncensored Subject: Re: MIGR export/import for database recovery/upgrades/selective mods

Those are very good points. I was never able to find a detailed description of the 'sendcommand' and the commands + parameters it can received (other than the 1-page on the Citadel.org website). If there is some detailed documentation for the 'sendcommand' it could be a good start.

Can anyone direct me/us to a good and detailed 'sendcommand' commands+parameters documentation?

Sat Nov 14 2020 08:16:30 EST from platonov @ Uncensored Subject: MIGR export/import for database recovery/upgrades/selective mods

I'd like to understand the "MIGR export/import" commands a lil bit deeper than a skin-deep level.
It seems to me that MIGR is a pretty flexible and powerful mechanism
for doing things like database repair and/or modification on either the entire database
or its sections: config, user, room, floor, message.

It seems that it also could be used for restoring just database sections or
even a selected few variables, parameters and so on.

For example if there is a database corruption you may loose
your config parameters, in which case you could simply edit
the last good XML created by MIGR export and copy the config
section to a separate XML file which you could then import and thus
recover your system parameters.

Yes, things get tricky when you start dealing with users,
rooms, floors or messages and if you change some things by editing
the XML file, you may create conflicts or loose the entire sections
of the database if yo

This is a response to the citadel support room thread:

Re: MIGR export/import for database recovery/upgrades/selective mods

Great to hear that. Actually, I had plenty of frustration in trying to find good info in Citadel docs and found that it takes WAY too much time to find things that could be found within minutes, if not seconds. Not that the info is not there, but you can't quite get to it and/or find it.

One of the things I found most valuable in any kind of writing, documentation or not, is the extensive TOC, pointing out every thing, be it some "small" issue or "large". Just because something is "small" does not mean it does not deserve to be found in table of contents. Otherwise, if it is THAT small that it "doesn't worth pointing it out", then why did you write it at all to begin with? Basically, all you have to do is to place the "small" things in less significant or noticeable places in TOC or on a deeper tree level.

Just by having the extensive TOC you increase the accessibility and locatability of info by orders of magnitude.

One other thing is local search engine. Why not use, for example, Solr search engine? You can index this entire collection and have every page indexed nearly instantly and have the REAL search engine results and not some quite unintuitive hack imitating the search engine functionality.

In fact, I can give the fully functional search engine code with php driven interface for indexing, search box and the rest of it and you'll have the entire documentation collection searchable in no time.

People underestimate the value and significance of information way too much and end up wasting orders of magnitudes in time, efforts and wasted energy, wasted for nothing.

One simple thing that can be done, and pretty fast, is creation of navigator page. Basically, the navigator page is a regular html page containing links to other places. You don't even have to have any actual information in the nav pages. All you need is links, like a tree structure of typical TOC. That nav page alone can be easily remembered, and, since it has the links to ALL the separate pages, all you need is that nav page to get to ANY info.

And if you have many small pages, each containing a short description of some item, topic, etc., then you create a nested, tree-like structured arrangement, where you do not include every small point in the main index of the navigator, but create a sub-toc.

Sun Nov 15 2020 17:37:25 EST from omatnet @ Uncensored Subject: Re: MIGR export/import for database recovery/upgrades/selective mods

Wow, that you so much! This is a great resource and should be on the Citadel website...! I can't believe I've been using Citadel for 8 years now, researching for info and learning to tweak it, and this is the first time I see such a good and comprehensive reference for using the 'sendcommand'

Thank you so much!!!

Sat Nov 14 2020 15:58:11 EST from platonov @ Uncensored Subject: Re: MIGR export/import for database recovery/upgrades/selective mods

Well, I can offer you a couple of key Citadel documents (see attachments here).

They are based on protocol and system_administration_manual. But they have been redone to include the extensive TOC and all sorts of formatting has been changed to make it all look the way I like to see things. Just unzip it and make sure css/main.css is present for the styles to work they way it was intended.

Protocol is actually that "good and detailed 'sendcommand' commands+parameters documentation".

So...

Sat Nov 14 2020 13:31:01 EST from omatnet @ Uncensored Subject: Re: MIGR export/import for database recovery/upgrades/selective mods

Those are very good points. I was never able to find a detailed description of the 'sendcommand' and the commands + parameters it can received (other than the 1-page on the Citadel.org website). If there is some detailed documentation for the 'sendcommand' it could be a good start.

Can anyone direct me/us to a good and detailed 'sendcommand' commands+parameters documentation?

Sat Nov 14 2020 08:16:30 EST from platonov @ Uncensored Subject: MIGR export/import for database recovery/upgrades/selective mods

I'd like to understand the "MIGR export/import" commands a lil bit deeper than a skin-deep level.
It seems to me that MIGR is a pretty flexible and powerful mechanism
for doing things like database repair and/or modification on either the entire database
or its sections: config, user, room, floor, message.

It seems that it also could be used for restoring just database sections or
even a selected few variables, parameters and so on.

For example if there is a database corruption you may loose
your config parameters, in which case you could simply edit
the last good XML created by MIGR export and copy the config
section to a separate XML file which you could then import and thus
recover your system parameters.

Yes, things get tricky when you start dealing with users,
rooms, floors or messages and if you change some things by editing
the XML file, you may create conflicts or loose the entire sections
of the database if yo

Logging this here for the time being..

Sun Nov 15 2020 10:11:29 AM EST from warbaby @ Uncensored Subject: Re: System Administration Manual needs fixing

Logged, I'll get to this as soon as I can.

Sun Nov 15 2020 04:42:01 AM EST from platonov @ Uncensored Subject: System Administration Manual needs fixing

There is an error in System Administration Manual:

https://citadel.org/system_administration_manual.html
in section Defining neighbor nodes, (lines 1728-1750) inside the <code> section. It has to do with unescaped angle brackets <> creating problems for web browser.

As a result all the rest of the document is displayed with strikethrough/strikeout text and it might look like it is a deliberate attempt to comment out an older version of document, no longer current and, therefore, not correct.

So, all the angle brackets better be properly escaped so that they are not mistakenly interpreted as valid code.

Also, the code needs to be placed inside the <pre>...</pre>

 

The Citadel documentation project is under way! 

Post your updates (fixes, corrections), notes, how-to's, tutorials, and System Administration recipes, right here..

If you're going to include anything more than a one liner.. the preferred format is markdown.

Just write your how-to in Markdown (Ghostwriter, Remarkable, whatever.. vi, vim, nano .. )

save it with a meaningful filename, and attach it here, with a subject that explains what it is..

Many thanks in advance for your contributions!

- Warbaby