🦐 Crangon

Crangon (named after the "Crangon crangon") is a fork of Bundlrs focused on a better user and admin experience.

Crangon optionally enables Guppy support for paste ownership!

Install

Crangon provides build scripts using just. It is required that bun, just, redis, and (obviously) Rust are installed before running.

Build:

# release (sqlite)
just
# release (mysql)
just build mysql
# release (postgres)
just build postgres
# documentation
just docs

Documentation is automatically built when building for release.

Run:

# test
just test
# release
just run

Crangon supports the features sqlite, postgres, and mysql. These features dictate which database types will be used.

Configuration

Crangon is configured through flags given when running the server. The following flags are available:

• --port 0000 optional (defaults to 8080)
• --static-dir "/path/to/dir optional (defaults to ./static)
• --db-type "type" optional (defaults to sqlite)

Environment variables:

• INFO optional (defaults to /pub/info)
• BODY_EMBED optional (defaults to nothing)
• DB_HOST "host" optional (defaults to localhost) (only if --db-type is postgres or mysql)
• DB_USER "user" required (only if --db-type is postgres or mysql)
• DB_PASS "pass" required (only if --db-type is postgres or mysql)
• DB_NAME "name" required (only if --db-type is postgres or mysql)
• SITE_NAME "name" optional (defaults to Crangon)
• AUTH_REQUIRED optional (defaults to (None)), disables creating pastes without an account
• REGISTRATION_DISABLED optional (defaults to (None))

Features

• Bundlrs Info Page
• Bundlrs README
• Crangon Info Page
• Crangon README
• Markdown Info Page
• Secondary Formatting Examples
• Templates Info Page
• Bundlrs API Docs
• Crangon API Docs

Boards

Boards are simple forum-like rooms that can be created by users. Boards can be made private by changing is_private to yes in their configuration page; however this will not stop users with the Staff role from viewing and posting on the board.

Boards can be given tags in their configuration. All tags must start with + and must be space separated.

User Accounts

Users can register for an account with just a username. They are given a unique ID which will be used as their password. This ID is stored hashed on the server and cannot be reset.

User Permissions

• ManagePastes - Ability to manage (edit metadata, delete) any paste
• ManageUsers - Ability to manage (edit metadata, delete) any user
• StaffDashboard - Ability to view the staff dashboard (/d/staff), as well as be unable to be viewed in the user manager

Levels should be directly managed by managing entries in the cr_logs table. Levels must have a logtype value of level. Their content should be in a JSON-serialized format following the structure defined here. Their elevation should be an int between -999 and 1000. An elevation of -1000 is used for anonymous users.

Here's an example content value for a basic staff role with all permissions:

{
    "elevation":5, "name":"staff", "permissions":[
        "ManagePastes",
        "ManageBoards",
        "ManageBoardPosts",
        "EditBoardPosts",
        "ManageUsers",
        "StaffDashboard"
    ]
}

Versus Bundlrs

• Crangon has no support for Puffer or Vibrant
• Crangon has partial support for Guppy
• Crangon does not support some Markdown features of Bundlrs
• Crangon makes difference API design choices
• Crangon has slight front-end UI differences