Admin setup

This file declares administrable resources via the admin! macro:

// src/admin.rs
use crate::entities::{users, articles};
use crate::forms::{RegisterForm, ArticleForm};

admin! {
    users: users::Model => RegisterForm {
        title: "Users",
    },
    articles: articles::Model => ArticleForm {
        title: "Articles",
    }
}

runique start

The daemon reads src/admin.rs, generates src/admins/ and launches cargo run. The src/admins/ folder is created automatically — do not edit it manually.

src/admins/
  ├── README.md
  ├── mod.rs
  └── admin_panel.rs

If src/admins/ already exists from a previous generation, runique start regenerates it.

mod admin;
mod admins;  // module generated by runique start

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

RuniqueApp::builder(config)
    .routes(url::routes())
    .with_database(db)
    .with_admin(|a| {
        a.site_title("Administration")
         .routes(admins::routes("/admin"))
         .with_state(admins::admin_state())
    })
    .build()
    .await?
    .run()
    .await?;

.routes() and .prefix() — two distinct settings

.routes(admins::routes("/site-admin")) sets where the admin lives. .prefix("secret") sets what is mounted in front of it. They compose:

Call order does not matter, and slashes are optional: secret, /secret and /secret/ are equivalent.

Version note — .prefix() used to replace the admin path, putting it in competition with .routes(): the last call won, and swapping the two lines silently changed the served URLs. It now prefixes, as its name promises. A project that used .prefix("/backoffice") to rename the admin should pass that path to admins::routes("/backoffice") instead.

Automatic robots.txt — When the admin panel is active, Runique automatically serves a /robots.txt route (a Sitemap: line when .sitemap(…) is set, plus the Content-Signal directives). Use .no_robots_txt() if you want to manage this file yourself.

The admin prefix is deliberately absent from it. robots.txt is a public file: writing Disallow: /my-prefix/ would publish the very path a custom prefix is often meant to keep discreet. And Disallow asks crawlers not to fetch, not to index — a URL known from elsewhere can still show up in results.

Exclusion is handled by the X-Robots-Tag: noindex, nofollow header, which Runique sets on every admin response — login page included, as well as redirects, errors and JSON replies. It leaks no path and stays in place even if you override the admin templates.

For business views that go beyond the generated CRUD (e.g. order detail with related lines, custom dashboard), declare extra routes in url.rs and register them via .extra_routes().

These routes automatically inherit the admin middleware: authentication, AdminState, PrototypeAdminState (sidebar), and CurrentUser.

Each route also names the resource it works on and the operation it performs (CrudOperation). The signed-in user needs the matching right on that resource, from their groups — the same check as the generated pages:

Without it, the user is sent back to the dashboard with an "insufficient rights" message. A resource key that isn't registered is a build error. Which rows and which columns the handler then reads or writes is up to the handler.

url.rs

use runique::admin::resource::CrudOperation;
use runique::axum::routing::MethodRouter;

pub fn admin_extra_routes() -> Vec<(&'static str, &'static str, CrudOperation, MethodRouter)> {
    vec![
        ("/orders/{number}/detail", "orders", CrudOperation::View, view!{ admin_order_detail }),
    ]
}

main.rs

.with_admin(|a| a
    .routes(admins::routes("/admin"))
    .extra_routes(url::admin_extra_routes())
)

Paths are relative to the admin prefix — /orders/{number}/detail becomes /admin/orders/{number}/detail.

Handler — retrieve the extensions injected by the middleware:

use runique::prelude::*;
use runique::admin::{AdminState, PrototypeAdminState, inject_admin_prefix, insert_admin_messages};

pub async fn admin_order_detail(
    Extension(admin): Extension<Arc<AdminState>>,
    Extension(proto): Extension<Arc<PrototypeAdminState>>,
    mut request: Request,
) -> AppResult<Response> {
    inject_admin_prefix(&mut request, &admin.config.prefix);
    insert_admin_messages(&mut request, proto.registry.all());
    // … business logic …
    request.render("admin/order_detail.html")
}

The template must extend admin_base to inherit the CSS and sidebar:

{% extends "admin_base" %}

runique create-superuser

Follows an interactive wizard to create the first admin account (is_superuser = true).

Once the server is running, the interface is available at:

http://localhost:{PORT}/admin/

The /admin/login page redirects to the dashboard if credentials are valid.