Skip to content

Admin Console

This page covers the daily actions administrators can perform in the admin console: user and team management, storage policies and policy groups, follower-node enrollment, background tasks, manual intervention for shares and locks, system settings, audit logs, and version information.
Jump to the section for what you need to do; you do not have to read it all.

The first successfully created account automatically becomes an administrator.
After logging in, administrators can enter Admin from the user menu in the top-right corner.

Admin Entry Quick Reference

What you want to doOpen firstContinue reading
View site-wide status, recent activity, task eventsAdmin -> OverviewThis page: Overview
Create users, change roles, change quotas, disable accountsAdmin -> UsersThis page: Users
Create teams, archive or restore team spacesAdmin -> TeamsThis page: Teams
Decide where files are actually storedAdmin -> Storage PoliciesStorage Policies
Connect another AsterDrive instance as a storage backendAdmin -> Follower NodesFollower Nodes
Connect OIDC / SSO loginAdmin -> External AuthThis page: External Auth
A user lost authenticator and recovery codesAdmin -> Users -> User DetailsThis page: Users
Route different users or teams to different storage pathsAdmin -> Policy GroupsStorage Policies
Inspect share links or stop abnormal sharesAdmin -> SharesThis page: Shares
See why background tasks failedAdmin -> TasksThis page: Tasks
Clean abnormal WebDAV / WOPI locksAdmin -> LocksThis page: Locks
Change registration, mail, public site URL, WOPI, trashAdmin -> System SettingsSystem Settings
Check who did whatAdmin -> Audit LogsThis page: Audit Logs

Our Restraint in the Admin Console

AsterDrive's admin console is intentionally not "fully featured".

Our judgment is:

  • Common things should take only a few clicks: disabling a user, changing quota, checking audit, or closing registration should not require reading documentation first
  • Uncommon things belong in CLI: database migration, batch configuration changes, and disaster recovery should go to Operations CLI, not be crammed into the web admin console
  • Dangerous things must state consequences: for force-delete-user or empty-trash actions, the button should say what will be deleted instead of hiding it behind an "advanced" menu

If a common action in the admin console feels unnecessarily roundabout, tell us. The direction of admin-console iteration is "shorter daily admin actions", not "more and more stacked features".

What Is in the Admin Console

The current left-side admin menu includes:

  • Overview
  • Users
  • Teams
  • Storage Policies
  • Follower Nodes
  • External Auth
  • Policy Groups
  • Shares
  • Tasks
  • Locks
  • System Settings
  • Audit Logs
  • About

Overview

Enter here when you want to see current site-wide status first.

You will see:

  • Total users, enabled users, disabled users
  • File count, total file size, underlying blob count
  • Share count
  • Last 7 days trend
  • Recent activity
  • Recent background task events
  • Daily summaries

Absolute times in the overview follow your currently configured display time zone. The last 7 days trend and daily summaries are also aggregated by this time zone.
If audit logs are disabled, trends and recent activity become much smaller or even empty; background task events continue to show.

Users

The Users page handles daily account-level management.

You can:

  • Create users
  • Search and filter users
  • Adjust roles and enabled status
  • Modify total quota
  • Bind a policy group to users
  • Open user details for more operations

In user details, you can also:

  • Reset the user's login password
  • Reset the user's MFA
  • Force all current devices for this user to log in again
  • View current space usage and quota

The system protects the initial administrator account to avoid accidentally disabling, demoting, or deleting the only administrator.

Resetting MFA applies when a user loses their authenticator and recovery codes. This clears the user's authenticator, recovery codes, and unfinished MFA login flows, and invalidates the user's current sessions. The user must bind an authenticator again after the next login.

Teams

The Teams page handles creation, archiving, restoration, and global maintenance of team workspaces.

You can:

  • Create teams
  • Choose the initial team administrator
  • Bind a usable policy group to a team
  • View member count, space usage, and archive status
  • Open team details to inspect members and team audit

After a team is created:

  • System administrators continue global maintenance here
  • Administrators and owners inside the team continue team-internal management from Settings -> Teams

Storage Policies

Storage policies decide two things:

  • Where files actually land
  • Which method writes files during upload

The current admin console supports three policy types:

  • local: local directory
  • s3: S3 or compatible object storage
  • remote: bound to a follower node, where another AsterDrive follower handles real object reads and writes

Here you can:

  • Create and edit policies
  • Test connections
  • Set the system default policy
  • Control the single-file size limit
  • Control chunk size
  • Choose relay_stream or presigned for S3

For policies already used by files, do not directly modify options that decide the real storage location, such as base_path, bucket, endpoint, or the bound follower node. To move locations, migrate old data first, then switch to the new policy.

Follower Nodes

The Follower Nodes page registers follower nodes, generates one-time enroll commands, and later tests connectivity from the primary to the follower.

You can:

  • Create remote node records
  • Fill name, namespace, and optional base_url
  • Generate the enroll command the follower needs to run after saving
  • View last test time, capability summary, and errors
  • Enable, disable, edit, or delete nodes
  • Create and maintain follower ingress targets in node details

Notes:

  • When base_url is empty, you can register and generate an enroll command first, but the primary node cannot actively test connectivity and cannot really send remote storage traffic to it
  • Ingress targets are pushed from the primary node to the follower; currently local and s3 are supported
  • A local ingress target only accepts a relative path, and it ultimately lands under the follower's server.follower.managed_ingress_local_root
  • Without an applied default ingress target, remote writes are rejected
  • Before deleting a node, rebind any remote storage policies that reference it
  • For the detailed flow, see Follower Nodes

External Auth

The External Auth page manages external identity providers shown on the login page. OpenID Connect is currently supported.

You can:

  • Create external authentication providers
  • Fill display name, icon, Issuer URL, Client ID, and optional Client Secret
  • Copy the redirect URI generated by AsterDrive and register it with the identity provider
  • Test whether discovery and JWKS are reachable
  • Restrict allowed email domains
  • Adjust claim mapping, such as username, display name, email, and email verification status
  • Control whether the identity provider must return a verified email
  • Control whether verified emails may auto-bind to local accounts
  • Control whether local regular users may be created automatically
  • Enable, disable, edit, or delete providers

The default policy is conservative: external identities are identified first by provider issuer and subject; email auto-binding must be enabled explicitly. Deleting a provider deletes the corresponding external identity bindings, but does not delete existing local users.

Configure public site URL first

External authentication redirect URIs depend on Admin -> System Settings -> Site Configuration -> Public site URL. If this is not set correctly, identity-provider callbacks land on the wrong address.

If an external identity cannot directly match a local account, the user may go through login-and-bind or email verification. Email verification depends on the external-login email verification template under Admin -> System Settings -> Mail Delivery.

Policy Groups

Policy groups decide "which storage policy a user or team should hit when uploading".

The most common patterns:

  • The default policy group has one rule, and all files use the default local policy
  • When using local and S3 together, split into multiple rules by file size
  • Different users or teams bind to different policy groups
  • Set one policy group as the default for new users

If you need to change upload routes, the usual order is:

  1. Prepare storage policies first
  2. Configure policy group rules
  3. Finally bind users or teams to the corresponding policy group

Policy groups can be disabled first. After disabling, they can no longer be assigned to new users.
If you need to delete a policy group that is still bound to users, first use the page's "migrate users" action to batch move bindings to another group, then delete it.

Shares

The Shares page lists all public links across the site.

Common uses:

  • A public link should no longer be accessible
  • A share is no longer needed
  • You want to check which materials are still public

Administrators can delete any share directly here.

Tasks

The Tasks page lists recorded background tasks in the system, including system periodic tasks, personal workspace tasks, and team tasks.

You will see:

  • Task name, type, source, and status
  • Current progress, recent activity time, and error summary
  • Online compression, online extraction, package download, and system runtime task records
  • Thumbnail generation task records
  • Archive preview generation task records

This page is best for:

  • Confirming whether a background task is actually running
  • Checking whether a group of tasks has been continuously failing recently
  • Filtering historical records by task type or status
  • Conditionally cleaning finished historical task records

Cleaning historical tasks only handles completed, failed, or canceled records. Queued, processing, and retrying tasks are not deleted.

Locks

The Locks page is for stuck locks.

The most common scenarios:

  • A file keeps showing as locked
  • A WebDAV client exited abnormally without releasing the lock
  • An administrator wants to clear a batch of expired locks

You can:

  • View current lock path, holder, and status
  • Clean expired locks
  • Force-unlock one lock

System Settings

System Settings maintains site-wide runtime rules.
The current page shows these groups:

  • Site Configuration
  • User Management
  • Authentication and Cookie
  • Mail Delivery
  • Network Access
  • Runtime and Scheduling
  • Storage and Retention
  • WebDAV
  • Audit Logs
  • Custom Configuration
  • Other

Commonly changed items include:

  • Public site URL
  • Titles, logo, and favicon for login page, share page, and main UI
  • Whether public registration is allowed
  • Whether email activation is required after registration
  • Whether browser cookies must be sent through HTTPS
  • Access / Refresh Token lifetimes
  • Expiration for registration activation, email-change, and password-reset links
  • MFA encryption key is not changed here; it belongs to [auth].mfa_secret_key in config.toml
  • WebDAV switch
  • Trash retention, version count, and team archive retention
  • Default quota for new users
  • Task retention and thumbnail source file size limit
  • Online extraction staging size limit
  • ZIP archive preview switches and limits
  • Media processors, vips / ffmpeg / ffprobe commands, and extension bindings
  • Mail queue, background task, and periodic cleanup frequency
  • Background task lane concurrency limits, maximum attempts, and system health check interval
  • Share streaming session TTL
  • Whether to record audit logs
  • Preview apps, and TTLs related to online Office / WOPI open methods
  • Gravatar avatar URL
  • CORS origin settings

For actual quota after creating a team space, verify it again on the Teams page.

If you plan to enable public registration, password recovery, or email change, configure the Mail Delivery group first.
If you plan to enable external authentication, configure Public site URL correctly first and copy the redirect URI from Admin -> External Auth to the identity provider. If you plan to connect online preview or online editing such as OnlyOffice, focus on:

  • Site Configuration -> Public site URL
  • Site Configuration -> Preview Apps
  • Callback network from the external Office / WOPI service to AsterDrive

In Preview Apps, you can enable, disable, and sort open methods directly, or import a group of WOPI apps through WOPI Discovery.
If the browser console clearly reports an AsterDrive API CORS error, add the corresponding origin to allowed CORS origins under Network Access.

Audit Logs

The Audit Logs page shows records of important operations.

Common uses:

  • Find who deleted a file
  • Find when a user logged in or changed content
  • Diagnose share, lock, and team-management issues
  • Check whether administrator operations happened as expected

Whether audit logs are recorded, and how long they are retained, are controlled by system settings.

About

The About page shows the current deployment version, license, repository, and documentation entry points.
When diagnosing "which version is actually running now", start here.

Administrator Routine Checklist

Confirm these items regularly:

  1. Whether Public site URL still points to real HTTP(S) origins; add each public entry point separately
  2. Whether the default storage policy and default policy group are still usable
  3. Whether policy groups bound to users and teams match current usage
  4. If follower nodes are connected, whether recent remote-node test status is normal
  5. Whether trash, version history, task artifacts, and team archive retention match current capacity
  6. Whether test mail can still be sent normally
  7. Whether there are share links that should no longer be public
  8. Whether there are long-failing or stuck background tasks
  9. Whether there are long-unreleased locks
  10. Whether audit logs are enabled and retained long enough

Released under the MIT License