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 built on Reddit’s open-source R2 codebase. It gives you everything you need to run a community: topic-organized branches, post and comment threads, voting and karma, wiki pages, flair, automated moderation, and a full OAuth2 API. Whether you’re building a niche community or a large-scale modding network, Artemis provides the tools to manage and grow it.

Quickstart

Get your Artemis instance running in minutes with the install script.

Core Features

Explore branches, posts, voting, wiki pages, and flair.

Moderation Tools

Learn how to manage your community with moderator tools and AutoModerator.

API Reference

Integrate with Artemis using the OAuth2 REST API.

How Artemis works

Artemis organizes content into branches — community spaces where members post links, text, and media. Other members vote on posts and comments, surfacing the best content. Moderators keep communities healthy using built-in tools and the AutoModerator rules engine.
1

Install Artemis

Download the source, run the install script on Ubuntu 14.04, and configure your domain. See the Installation guide for full steps.
2

Create your first branch

Log in as an admin, navigate to /branches/create, and set up your first community space with a name, description, and rules.
3

Invite members and start posting

Share your domain with members. They can register, subscribe to branches, and start posting immediately.
4

Connect via the API

Register an OAuth2 app at /prefs/apps to integrate bots, tools, or third-party clients using the OAuth2 API.

Key capabilities

Branches

Create and manage community spaces with custom rules, flair, and wikis.

AutoModerator

Automate moderation with YAML-based rules that act on posts and comments.

OAuth2 API

Build apps and bots with scoped OAuth2 tokens and a full REST API.

Plugin system

Extend Artemis with custom plugins that hook into the platform lifecycle.

Build docs developers (and LLMs) love