File reference

Start with what you want to change. Each section follows the relevant files in the order you would usually read them.

Trace a request

cgi-bin/chat.pl
Start here to trace a CGI request through startup, configuration, and dispatch.
cgi-bin/Sources/RequestContext.pm
Check the per-request state when a value survives unexpectedly in a persistent worker.
cgi-bin/Settings.static.dat
Find the module registered for an action, slash command, template variable, or hook.

Follow a chat message

cgi-bin/Sources/SendRequest.pm
Start at the send request and follow its validation and submission handling.
cgi-bin/Sources/Send.pm
Follow command dispatch, filter hooks, and selection of recipients.
cgi-bin/Sources/RecipientDelivery.pm
Trace how messages reach the selected sessions.
cgi-bin/Sources/DeliveryJournal.pm
Look here for cursors and replay on the experimental delivery path.
cgi-bin/Sources/RoomHistory.pm
Check which recent room messages are stored and can be restored.
www/message-events.js
Trace how the browser turns a typed event into an update to the transcript or roster.

Change registration or member handling

cgi-bin/Sources/Register.pm
Follow form submission through account creation.
cgi-bin/Sources/RegistrationPolicy.pm
Change or check the rules for names, email patterns, age, and approval.
cgi-bin/Sources/AccountGateway.pm
Use the account boundary when looking up or changing a registered member.
cgi-bin/Sources/MemberIndex.pm
Inspect nickname lookup and the index used by the directory and search.

Add a setting or change the news editor

cgi-bin/SiteSettings.default.dat
Set the defaults for new installations. Existing installations can have their own saved values.
cgi-bin/Plugins/Administration/Settings.pm
Find the admin action that validates and saves the corresponding form.
cgi-bin/Sources/SettingsStore.pm
Follow version checks and persistence for site settings.
cgi-bin/Plugins/Administration/News.pm
Follow article preview, publishing, and deletion.
cgi-bin/Templates/admin/news_edit.html
Edit the fields and actions in the article form.

Change a page or its wording

cgi-bin/Templates/login.html
Start with this template to change the public sign-in page.
cgi-bin/Templates/chat.html
Change the structure of the chat shell. The template includes the composer, toolbar, roster, and transcript frame.
www/style.css
Find shared styles for public pages, chat, administration, and the light and dark palettes.
cgi-bin/english.lng
Add an English label and give its German translation the same key in german.lng.
cgi-bin/german.lng
Add the corresponding German text. The shared templates use translation keys.

Run the chat locally

README.md
Start here for prerequisites, the first installation, and web server examples.
tools/run-local.sh
Start the developer CGI server and point it at your local installation.
tools/local_server.py
Inspect how the local server serves assets and forwards a request to Perl.
Browse the file index

408 files

cgi-bin/Sources 108
  • cgi-bin/Sources/.htaccess
  • cgi-bin/Sources/AccountFileIndex.pm
  • cgi-bin/Sources/AccountGateway.pm
  • cgi-bin/Sources/AccountRecord.pm
  • cgi-bin/Sources/AuthTokens.pm
  • cgi-bin/Sources/BanRepository.pm
  • cgi-bin/Sources/BanRules.pm
  • cgi-bin/Sources/BanService.pm
  • cgi-bin/Sources/block_handlers.pm
  • cgi-bin/Sources/ByteWriter.pm
  • cgi-bin/Sources/Capacity.pm
  • cgi-bin/Sources/CaptchaVerifier.pm
  • cgi-bin/Sources/ChatHistory.pm
  • cgi-bin/Sources/CleanupJobs.pm
  • cgi-bin/Sources/ClientIdentity.pm
  • cgi-bin/Sources/ConfigurationRepository.pm
  • cgi-bin/Sources/CredentialService.pm
  • cgi-bin/Sources/Crypt.pm
  • cgi-bin/Sources/Definitions.pm
  • cgi-bin/Sources/DeliveryJournal.pm
  • cgi-bin/Sources/EmailChange.pm
  • cgi-bin/Sources/Enum.pm
  • cgi-bin/Sources/environment_loader.pm
  • cgi-bin/Sources/FileAccountRepository.pm
  • cgi-bin/Sources/FileBanStore.pm
  • cgi-bin/Sources/FileConfigurationStore.pm
  • cgi-bin/Sources/FileGrantStore.pm
  • cgi-bin/Sources/FileIdentity.pm
  • cgi-bin/Sources/FileIdentityMigration.pm
  • cgi-bin/Sources/FileInboxStore.pm
  • cgi-bin/Sources/FileNewsStore.pm
  • cgi-bin/Sources/FileRoomRepository.pm
  • cgi-bin/Sources/FileSessionStore.pm
  • cgi-bin/Sources/FileTrafficStore.pm
  • cgi-bin/Sources/FileTransaction.pm
  • cgi-bin/Sources/GrantRecord.pm
  • cgi-bin/Sources/GrantRepository.pm
  • cgi-bin/Sources/HostResolver.pm
  • cgi-bin/Sources/ImageUploadService.pm
  • cgi-bin/Sources/InboxRepository.pm
  • cgi-bin/Sources/Info.pm
  • cgi-bin/Sources/Install.pm
  • cgi-bin/Sources/joinedhash.pm
  • cgi-bin/Sources/Login.pm
  • cgi-bin/Sources/Logout.pm
  • cgi-bin/Sources/LogPage.pm
  • cgi-bin/Sources/LogReader.pm
  • cgi-bin/Sources/MailDelivery.pm
  • cgi-bin/Sources/MemberIndex.pm
  • cgi-bin/Sources/MemberStore.pm
  • cgi-bin/Sources/MessageEvents.pm
  • cgi-bin/Sources/Messages.pm
  • cgi-bin/Sources/ModifyProfile.pm
  • cgi-bin/Sources/ModifyRoom.pm
  • cgi-bin/Sources/Mutation.pm
  • cgi-bin/Sources/MutationPolicy.pm
  • cgi-bin/Sources/NetworkDiagnostic.pm
  • cgi-bin/Sources/NewsArticles.pm
  • cgi-bin/Sources/NewsRepository.pm
  • cgi-bin/Sources/NewsService.pm
  • cgi-bin/Sources/PendingModeration.pm
  • cgi-bin/Sources/PipeWriter.pm
  • cgi-bin/Sources/PollingQueue.pm
  • cgi-bin/Sources/PrincipalLifecycle.pm
  • cgi-bin/Sources/PrivateHistory.pm
  • cgi-bin/Sources/PrivateMessageRecord.pm
  • cgi-bin/Sources/PrivateMessageService.pm
  • cgi-bin/Sources/ProcessRunner.pm
  • cgi-bin/Sources/RateFileStore.pm
  • cgi-bin/Sources/RateLimiter.pm
  • cgi-bin/Sources/RecipientDelivery.pm
  • cgi-bin/Sources/RecordSnapshots.pm
  • cgi-bin/Sources/Register.pm
  • cgi-bin/Sources/RegistrationPolicy.pm
  • cgi-bin/Sources/RequestBody.pm
  • cgi-bin/Sources/RequestContext.pm
  • cgi-bin/Sources/ResetPassword.pm
  • cgi-bin/Sources/RoomAccessService.pm
  • cgi-bin/Sources/RoomEdit.pm
  • cgi-bin/Sources/RoomFileIndex.pm
  • cgi-bin/Sources/RoomHistory.pm
  • cgi-bin/Sources/RoomIndex.pm
  • cgi-bin/Sources/RoomPolicy.pm
  • cgi-bin/Sources/RoomRecord.pm
  • cgi-bin/Sources/RoomRoleIndex.pm
  • cgi-bin/Sources/RotatingLog.pm
  • cgi-bin/Sources/Send.pm
  • cgi-bin/Sources/SendRequest.pm
  • cgi-bin/Sources/SessionAccess.pm
  • cgi-bin/Sources/SessionFileIndex.pm
  • cgi-bin/Sources/SessionRecord.pm
  • cgi-bin/Sources/SessionRepository.pm
  • cgi-bin/Sources/SessionService.pm
  • cgi-bin/Sources/SessionWrite.pm
  • cgi-bin/Sources/SettingsStore.pm
  • cgi-bin/Sources/SimpleTemplateEngine.pm
  • cgi-bin/Sources/SimpleTemplateEnginePerl.pm
  • cgi-bin/Sources/Stash.pm
  • cgi-bin/Sources/StreamReader.pm
  • cgi-bin/Sources/Subs.pm
  • cgi-bin/Sources/tag_handlers.pm
  • cgi-bin/Sources/TemplateCondition.pm
  • cgi-bin/Sources/TrafficCounter.pm
  • cgi-bin/Sources/TrafficRepository.pm
  • cgi-bin/Sources/TrafficStatistics.pm
  • cgi-bin/Sources/WaitingRoom.pm
  • cgi-bin/Sources/WebAddress.pm
  • cgi-bin/Sources/WorkerSlots.pm
cgi-bin/Plugins 59
  • cgi-bin/Plugins/.htaccess
  • cgi-bin/Plugins/Administration/CleanupMembers.pm
  • cgi-bin/Plugins/Administration/Log.pm
  • cgi-bin/Plugins/Administration/Menu.pm
  • cgi-bin/Plugins/Administration/News.pm
  • cgi-bin/Plugins/Administration/Settings.pm
  • cgi-bin/Plugins/BanList.pm
  • cgi-bin/Plugins/BasicAuth.pm
  • cgi-bin/Plugins/CommandHandlers/AdminCommands.pm
  • cgi-bin/Plugins/CommandHandlers/Ignoring.pm
  • cgi-bin/Plugins/CommandHandlers/Invitations.pm
  • cgi-bin/Plugins/CommandHandlers/MiscCommands.pm
  • cgi-bin/Plugins/CommandHandlers/ModerationCommands.pm
  • cgi-bin/Plugins/CommandHandlers/PrivateMessages.pm
  • cgi-bin/Plugins/CommandHandlers/TextCommands.pm
  • cgi-bin/Plugins/CookieHandler.pm
  • cgi-bin/Plugins/DataModules/OnlineModule.pm
  • cgi-bin/Plugins/DataModules/RoomModule.pm
  • cgi-bin/Plugins/DataModules/UserModule.pm
  • cgi-bin/Plugins/GuestLogin.pm
  • cgi-bin/Plugins/index.html
  • cgi-bin/Plugins/Logging/MessagesLog.pm
  • cgi-bin/Plugins/Logging/TrafficLog.pm
  • cgi-bin/Plugins/Logging/UsersLog.pm
  • cgi-bin/Plugins/MailModules/MailTransportModule.pm
  • cgi-bin/Plugins/MaxUsers.pm
  • cgi-bin/Plugins/Moderation.pm
  • cgi-bin/Plugins/Output.pm
  • cgi-bin/Plugins/PipeModules/SysVPipeModule.pm
  • cgi-bin/Plugins/PipeModules/Win32PipeModule.pm
  • cgi-bin/Plugins/ProfileCheck.pm
  • cgi-bin/Plugins/ProxyCheck.pm
  • cgi-bin/Plugins/RegistrationMail.pm
  • cgi-bin/Plugins/Reminder.pm
  • cgi-bin/Plugins/RoomCheck.pm
  • cgi-bin/Plugins/RouteTracer.pm
  • cgi-bin/Plugins/Search.pm
  • cgi-bin/Plugins/SimpleTemplateEngine/FilterTags.pm
  • cgi-bin/Plugins/SimpleTemplateEngine/GroupTags.pm
  • cgi-bin/Plugins/SimpleTemplateEngine/IncludeTags.pm
  • cgi-bin/Plugins/SimpleTemplateEngine/TimeTags.pm
  • cgi-bin/Plugins/SimpleTemplateEngine/UpdateTags.pm
  • cgi-bin/Plugins/SystemMessages.pm
  • cgi-bin/Plugins/TemplateEngines/EmbedderTemplateEngine.pm
  • cgi-bin/Plugins/TemplateEngines/EmbperlTemplateEngine.pm
  • cgi-bin/Plugins/TemplateEngines/LanguageIndependentTemplateEngine.pm
  • cgi-bin/Plugins/TemplateEngines/MasonTemplateEngine.pm
  • cgi-bin/Plugins/TemplateEngines/MicroMasonTemplateEngine.pm
  • cgi-bin/Plugins/TemplateEngines/ToolkitTemplateEngine.pm
  • cgi-bin/Plugins/TemplateEngines/XPPTemplateEngine.pm
  • cgi-bin/Plugins/TextFilters/Converters.pm
  • cgi-bin/Plugins/TextFilters/Formatting.pm
  • cgi-bin/Plugins/VarHandlers/AllUsers.pm
  • cgi-bin/Plugins/VarHandlers/CommandsList.pm
  • cgi-bin/Plugins/VarHandlers/News.pm
  • cgi-bin/Plugins/VarHandlers/Permissions.pm
  • cgi-bin/Plugins/VarHandlers/ProfileLoader.pm
  • cgi-bin/Plugins/VarHandlers/Roomlist.pm
  • cgi-bin/Plugins/VarHandlers/RoomLoader.pm
cgi-bin/Templates 131
  • cgi-bin/Templates/account.html
  • cgi-bin/Templates/admin/alias_editor.html
  • cgi-bin/Templates/admin/alias_editor_row.html
  • cgi-bin/Templates/admin/boolean_choice.html
  • cgi-bin/Templates/admin/capacity.html
  • cgi-bin/Templates/admin/captcha_settings.html
  • cgi-bin/Templates/admin/cleanupmembers.html
  • cgi-bin/Templates/admin/cleanupmembers_processing.html
  • cgi-bin/Templates/admin/color_aliases.html
  • cgi-bin/Templates/admin/command_aliases.html
  • cgi-bin/Templates/admin/commandpermissions.html
  • cgi-bin/Templates/admin/defaults.html
  • cgi-bin/Templates/admin/general_settings.html
  • cgi-bin/Templates/admin/images.html
  • cgi-bin/Templates/admin/log.html
  • cgi-bin/Templates/admin/log_bottom.html
  • cgi-bin/Templates/admin/log_entry.html
  • cgi-bin/Templates/admin/log_top.html
  • cgi-bin/Templates/admin/mail_settings.html
  • cgi-bin/Templates/admin/maintenance.html
  • cgi-bin/Templates/admin/menu.html
  • cgi-bin/Templates/admin/menu_back.html
  • cgi-bin/Templates/admin/news.html
  • cgi-bin/Templates/admin/news_edit.html
  • cgi-bin/Templates/admin/permissions.html
  • cgi-bin/Templates/admin/policy_pages.html
  • cgi-bin/Templates/admin/registration.html
  • cgi-bin/Templates/admin/registration_pending.html
  • cgi-bin/Templates/admin/registration_status.html
  • cgi-bin/Templates/admin/section_end.html
  • cgi-bin/Templates/admin/section_start.html
  • cgi-bin/Templates/admin/smiley_add.html
  • cgi-bin/Templates/admin/smileys.html
  • cgi-bin/Templates/allnews.html
  • cgi-bin/Templates/allusers.html
  • cgi-bin/Templates/captcha_scripts.html
  • cgi-bin/Templates/chat.html
  • cgi-bin/Templates/chatentrance.html
  • cgi-bin/Templates/commands.html
  • cgi-bin/Templates/counter_js.html
  • cgi-bin/Templates/counter_ssi.html
  • cgi-bin/Templates/deleted.html
  • cgi-bin/Templates/dereferer.html
  • cgi-bin/Templates/download.html
  • cgi-bin/Templates/editprofile.html
  • cgi-bin/Templates/editprofile_commandpermissions.html
  • cgi-bin/Templates/editprofile_permissions.html
  • cgi-bin/Templates/editroom.html
  • cgi-bin/Templates/error.html
  • cgi-bin/Templates/form_required_marker.html
  • cgi-bin/Templates/form_required_note.html
  • cgi-bin/Templates/input.html
  • cgi-bin/Templates/install.html
  • cgi-bin/Templates/install_license.html
  • cgi-bin/Templates/install_locked.html
  • cgi-bin/Templates/install_unlock.html
  • cgi-bin/Templates/log.html
  • cgi-bin/Templates/login.html
  • cgi-bin/Templates/logout.html
  • cgi-bin/Templates/mails/email_change.mail
  • cgi-bin/Templates/mails/membercleanup_deleted.mail
  • cgi-bin/Templates/mails/membercleanup_warning.mail
  • cgi-bin/Templates/mails/registration.mail
  • cgi-bin/Templates/mails/registration_approved.mail
  • cgi-bin/Templates/mails/reminder.mail
  • cgi-bin/Templates/maintenance.html
  • cgi-bin/Templates/menu.html
  • cgi-bin/Templates/message.html
  • cgi-bin/Templates/messages/admin.html
  • cgi-bin/Templates/messages/alive.html
  • cgi-bin/Templates/messages/broadcast.html
  • cgi-bin/Templates/messages/callop.html
  • cgi-bin/Templates/messages/changed.html
  • cgi-bin/Templates/messages/color_changed.html
  • cgi-bin/Templates/messages/entered.html
  • cgi-bin/Templates/messages/img.html
  • cgi-bin/Templates/messages/leaved.html
  • cgi-bin/Templates/messages/me.html
  • cgi-bin/Templates/messages/message.html
  • cgi-bin/Templates/messages/moderated_sent.html
  • cgi-bin/Templates/messages/moderated_text.html
  • cgi-bin/Templates/messages/moderation_disable.html
  • cgi-bin/Templates/messages/nick_changed.html
  • cgi-bin/Templates/messages/offline_sent.html
  • cgi-bin/Templates/messages/private.html
  • cgi-bin/Templates/messages/private_fragment.html
  • cgi-bin/Templates/messages/private_sent.html
  • cgi-bin/Templates/messages/quit.html
  • cgi-bin/Templates/messages/registration_pending.html
  • cgi-bin/Templates/messages/room_changed.html
  • cgi-bin/Templates/messages/text.html
  • cgi-bin/Templates/messages/user_changed.html
  • cgi-bin/Templates/messages_bottom.html
  • cgi-bin/Templates/messages_top.html
  • cgi-bin/Templates/moderated.html
  • cgi-bin/Templates/news_card.html
  • cgi-bin/Templates/not_found.html
  • cgi-bin/Templates/offline/private.html
  • cgi-bin/Templates/offlinemsgs.html
  • cgi-bin/Templates/palette.html
  • cgi-bin/Templates/palette_preferences.html
  • cgi-bin/Templates/private_frames.html
  • cgi-bin/Templates/private_input.html
  • cgi-bin/Templates/private_messages_top.html
  • cgi-bin/Templates/profile.html
  • cgi-bin/Templates/profile_commandpermissions.html
  • cgi-bin/Templates/profile_permissions.html
  • cgi-bin/Templates/proxycheck_bottom.html
  • cgi-bin/Templates/proxycheck_top.html
  • cgi-bin/Templates/public_footer.html
  • cgi-bin/Templates/public_header.html
  • cgi-bin/Templates/register.html
  • cgi-bin/Templates/register_birthdate.html
  • cgi-bin/Templates/register_success.html
  • cgi-bin/Templates/reminder.html
  • cgi-bin/Templates/reminder_success.html
  • cgi-bin/Templates/resetpassword.html
  • cgi-bin/Templates/room_users.html
  • cgi-bin/Templates/roomlist.html
  • cgi-bin/Templates/rooms.html
  • cgi-bin/Templates/search.html
  • cgi-bin/Templates/search_results.html
  • cgi-bin/Templates/secondary.html
  • cgi-bin/Templates/send_output.html
  • cgi-bin/Templates/site_policy.html
  • cgi-bin/Templates/smileys.html
  • cgi-bin/Templates/styles.html
  • cgi-bin/Templates/traceroute.html
  • cgi-bin/Templates/users.html
  • cgi-bin/Templates/verifyemail.html
  • cgi-bin/Templates/waiting_room.html
cgi-bin 12
  • cgi-bin/.htaccess
  • cgi-bin/chat.pl
  • cgi-bin/english.admin
  • cgi-bin/english.commands
  • cgi-bin/english.lng
  • cgi-bin/english.permissions
  • cgi-bin/german.admin
  • cgi-bin/german.commands
  • cgi-bin/german.lng
  • cgi-bin/german.permissions
  • cgi-bin/Settings.static.dat
  • cgi-bin/SiteSettings.default.dat
www 89
  • www/admin-aliases.js
  • www/admin-workspace.js
  • www/admin.js
  • www/appearance-palettes.js
  • www/captcha.js
  • www/chat-history.js
  • www/chat.js
  • www/dummy.html
  • www/general.js
  • www/images.css
  • www/images/angry.gif
  • www/images/at.gif
  • www/images/blank.gif
  • www/images/blue.gif
  • www/images/chat-at-home-small.webp
  • www/images/chat-at-home.webp
  • www/images/cheesy.gif
  • www/images/cool.gif
  • www/images/down.gif
  • www/images/edit.gif
  • www/images/english.gif
  • www/images/error.gif
  • www/images/fist.gif
  • www/images/german.gif
  • www/images/green.gif
  • www/images/grin.gif
  • www/images/huh.gif
  • www/images/kiss.gif
  • www/images/line0.gif
  • www/images/line1.gif
  • www/images/line2.gif
  • www/images/line3.gif
  • www/images/menu.gif
  • www/images/menu_admin.gif
  • www/images/menu_adminmode.gif
  • www/images/menu_color.gif
  • www/images/menu_help.gif
  • www/images/menu_log.gif
  • www/images/menu_logout.gif
  • www/images/menu_nosmileys.gif
  • www/images/menu_profile.gif
  • www/images/menu_rooms.gif
  • www/images/menu_scrolling.gif
  • www/images/menu_separator.gif
  • www/images/menu_showtime.gif
  • www/images/menu_smileys.gif
  • www/images/menu_usersearch.gif
  • www/images/minimize.gif
  • www/images/msg.gif
  • www/images/palette.gif
  • www/images/question.gif
  • www/images/remove.gif
  • www/images/restore.gif
  • www/images/rtfm.gif
  • www/images/sad.gif
  • www/images/send.gif
  • www/images/shocked.gif
  • www/images/smiley.gif
  • www/images/smiley1.gif
  • www/images/smiley10.gif
  • www/images/smiley11.gif
  • www/images/smiley12.gif
  • www/images/smiley13.gif
  • www/images/smiley2.gif
  • www/images/smiley3.gif
  • www/images/smiley4.gif
  • www/images/smiley5.gif
  • www/images/smiley6.gif
  • www/images/smiley7.gif
  • www/images/smiley8.gif
  • www/images/smiley9.gif
  • www/images/up.gif
  • www/images/wink.gif
  • www/message-content.js
  • www/message-events.js
  • www/message-packets.js
  • www/messages.js
  • www/moderated.js
  • www/news-editor.js
  • www/private-messages.js
  • www/responsive-tables.js
  • www/send-output.js
  • www/session-log.js
  • www/style.css
  • www/vendor/dompurify-3.4.18/LICENSE
  • www/vendor/dompurify-3.4.18/manifest.json
  • www/vendor/dompurify-3.4.18/purify.es.js
  • www/vendor/dompurify-3.4.18/README.md
  • www/waiting-room.js
ops 4
  • ops/gtchat-fastcgi.pl
  • ops/room-history-backup.pl
  • ops/systemd/gtchat-fastcgi.service
  • ops/systemd/gtchat-fastcgi.socket
tools 2
  • tools/local_server.py
  • tools/run-local.sh
Project files 3
  • LICENSE-DE.md
  • LICENSE-EN.md
  • README.md