Admin setup

• A Runique project with a configured database and applied migrations (runique migration up)

• The admin feature enabled in Cargo.toml:

  runique = { version = "4.0.0", features = ["postgres", "admin"] }
  

• Models declared via model! (generated SeaORM entities)

A config function takes AdminStaging and registers models:

// src/admin.rs
use crate::entities::{article, user_profile};
use runique::admin::{AdminSite, ModelAdmin};
use runique::app::staging::AdminStaging;

pub fn config(admin: AdminStaging) -> AdminStaging {
    admin
        .site_title("Administration")
        .path("/admin/")
        .page_size(20)
        .site(site)
}

fn site(site: AdminSite) -> AdminSite {
    site.accounts_users(accounts())
        .register(articles())
}

fn accounts() -> ModelAdmin<user_profile::Entity> {
    use user_profile::Column::*;
    ModelAdmin::new()
        .list(|l| {
            l.display([Username, Email, IsActive])
                .sortable([Username])
                .search([Username, Email])
        })
        .form(|f| f.fields([Username, Email]))
}

fn articles() -> ModelAdmin<article::Entity> {
    use article::Column::*;
    ModelAdmin::new()
        .title("Articles")
        .list(|l| l.display([Title, Status]).links([Title]).filter([Status]))
        .form(|f| f.fields([Title, Body, Status]))
}

Notes:

• accounts_users(...) replaces the framework's accounts admin with yours, built on your extend! of eihwaz_users. It is the only way to replace it: registering a model under the accounts' key refuses the boot.
• register(...) adds a business model. Register every model!{}: at boot, group rights targeting an unregistered model are deleted from the database.
• Accounts and groups already exist in the framework; you do not recreate them

// src/main.rs
mod admin;

No generated src/admins/ folder: everything lives in your admin.rs.

use runique::app::builder::RuniqueAppBuilder as builder;

builder::new(config)
    .routes(url::routes())
    .with_database(db)
    .with_admin(admin::config)
    .build()
    .await?
    .run()
    .await?;

In production (RUNIQUE_ENV=prod), add .with_public_url("https://my-site.com"): without it, the boot is refused as soon as the admin is enabled. Links sent by email (account creation, reset) are built on this address, never on the request's Host header, which an attacker can forge. With RUNIQUE_ENV=dev, it is always http://127.0.0.1:{PORT}.

Or an inline closure:

.with_admin(|a| {
    a.site_title("Admin")
        .path("/admin/")
        .site(|s| s.register(ModelAdmin::<article::Entity>::new()))
})

runique create-superuser

The command asks for the hashing algorithm, the username, the email and the password, then creates an active account with is_superuser. The superuser has every right; then name a dirigeant from an account's page (rank form) for everyday use. See Permissions.

Config is validated at startup. demo-app replays the same checks in a unit test:

#[test]
fn every_registered_model_passes_the_boot_checks() {
    let staging = super::config(AdminStaging::new().enable());
    if let Err(e) = staging.validate() {
        panic!("{e}");
    }
}