Skip to content

Subreddit Wikis

Erin edited this page May 2, 2019 · 3 revisions

Subreddit wiki storage

Toolbox uses Reddit wiki pages for most of its storage. This page documents what gets stored where.

Toolbox configuration for each subreddit is stored in wiki pages on that sub:

  • The /r/<sub>/wiki/toolbox page stores general configuration information. Removal reasons, mod macros, domain tags, and usernote type configuration are all stored on this page.
  • The /r/<sub>/wiki/usernotes page stores compressed usernotes data and other supporting information.

Additionally, there are some personal data stored in subreddits of the user's choice (usually a personal subreddit, as multiple mods using these wikis on a single sub will result in bad things):

  • Pages of the form /r/<sub>/wiki/notes/<name> store personal notes in plain text. The personal notes module of Toolbox is essentially just an alternate interface for editing these pages, so there is no special format for them.
  • The /r/<sub>/wiki/tbsettings page stores a backup of personal Toolbox settings for a given user. Users should not generate this page on subreddits they moderate; instead, backups should be sent to a personal subreddit owned by the user. External applications/scripts should not create, modify, or rely on the existence of this page, but may attempt to read it to pull preferences for the active user. Document format TODO