Obelisk Docs
/
Introduction

Getting Started

Add Obelisk, let it create what it needs, and check its permissions.

1. Add Obelisk to your server

Use the Add to Discord button on the home page. You need the Manage Server permission in the server you add it to. Make sure the invite includes slash commands; brand-new commands can take a little while to appear in Discord.

2. Run the setup

Run /setup as the server owner or an administrator.

  • Without options, /setup explains the install order: choose what to set up, compare permissions, authorize if needed, re-check, run setup, then turn Administrator off if it is still on.
  • With confirm turned on, Obelisk checks its permissions, then creates the default channels and roles (such as the Verified and Quarantine roles) and turns on the settings for the chosen features. A failed item does not cancel the rest.
  • If permissions are missing, Obelisk replies with an authorize link containing exactly the permissions it needs and the steps to add them by hand. Authorize, then press Re-check.

3. Permissions

Obelisk does not ask for Administrator as its normal set of permissions. The setup adds up only what your chosen features need, for example Manage Roles, Manage Channels, Ban Members, Moderate Members and View Audit Log.

The quick_admin option adds temporary Administrator to the authorize link so setup can create channels and roles even when something is in the way. After setup, turn it off: Server Settings → Roles → the Obelisk role → Permissions → Administrator off → Save. Discord manages that role, so Obelisk can't remove Administrator from itself.

Role order matters. Obelisk can’t edit or punish anything above its own role. Keep the Obelisk role above the roles it should manage (Verified, Quarantine) and above members it should be able to punish.

4. Channel access

If Obelisk can’t see one of its own channels (log, honeypot, verification or lockdown channel), run /fix_permissions. Turn on dry_run to preview the changes without editing anything.

5. Check everything

Run /selftest for a dry run of every Obelisk check. Nothing in the server is changed.

Next steps