Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/artemis-development-group/artemis/llms.txt

Use this file to discover all available pages before exploring further.

Artemis is a self-hosted social forum platform forked from Reddit’s open-source R2 codebase. It gives operators a complete community stack — topic-organized branches, threaded posts and comments, voting, wiki pages, automated moderation, and a full OAuth2 API — running entirely on infrastructure you control.

Quickstart

Install Artemis on Ubuntu 14.04 and have your instance running in under an hour.

Configuration

Set install variables, choose plugins, and configure development vs. production mode.

Moderation tools

Manage your community with moderator queues, AutoModerator rules, and ban controls.

API reference

Build bots and integrations with the scoped OAuth2 REST API.

What Artemis provides

Artemis organizes content into branches — community spaces where members submit links, text posts, and media. Other members vote on submissions and comments, surfacing the best content. Moderators keep communities healthy using built-in queues and the AutoModerator rules engine. Key capabilities out of the box:
  • Branches — create themed communities with custom rules, flair, stylesheets, and subscriber lists
  • Posts and comments — threaded link and text submissions with inline reply trees
  • Voting and karma — upvote/downvote scoring with time-decayed ranking (hot, top, new, rising, controversial)
  • Moderation — report queues, spam filters, ban management, mod logs, and AutoModerator YAML rules
  • Wiki — per-branch wiki pages with revision history and access controls
  • OAuth2 API — standard authorization code and client credentials flows with scoped token access
  • Plugin system — extend or override platform behavior by installing plugins alongside the core r2 app

Architecture

Artemis is composed of several services that work together behind a HAProxy load balancer:
ServiceDescription
r2The main Python/Pylons web application. Handles all page rendering, API endpoints, and background job consumers.
artemis-websocketsWebSocket push service (baseplate-serve2, port 9001). Delivers real-time updates to connected clients.
artemis-activityActivity tracking service (baseplate-serve2, port 9002). Records and queries user activity signals.
nginxServes static media files (port 9000) and the pixel/click tracker (port 8082). Also terminates SSL on port 443.
HAProxyFront-end load balancer on port 80/443 that routes requests to the correct backend based on path.
PostgreSQLPrimary relational database for accounts, branches, and structured data.
CassandraWide-column store for high-volume data such as votes, traffic, and inbox items.
memcached / mcrouterDistributed cache layer in front of the database.
RabbitMQMessage queue for background job consumers (vote counting, comment trees, search indexing, etc.).
Artemis requires Ubuntu 14.04 Trusty Tahr (amd64). The install script depends on packages from a PPA that is only built for that release. Running a Docker image of Trusty Tahr on a modern host is the recommended approach for keeping the host OS current while meeting this requirement.

Build docs developers (and LLMs) love