Admin changes by Ulincsys · Pull Request #3737 · augurlabs/augur

Ulincsys · 2026-02-25T01:17:32Z

Description

Add admin dashboard
Add admin API routes
Add admin_required decorator to protect admin routes

Notes for Reviewers

There's a lot more work to do on this interface, but I'd like to get it into main so it stays up to date instead of lagging behind again.
Admin users cannot be created via the frontend, and must be added via the augur user add command with the --admin flag

Signed commits

Yes, I signed my commits.

Add @requires_admin decorator Add clarity to backend start error status Signed-off-by: Ulincsys <ulincsys@gmail.com>

- Add ssl decorator to config endpoints - Fix syntax error in admin_required decorator - Update dashboard endpoint to use config class directly - Update dashboard styles with more consistent colors - Implement config update functionality in admin dashboard Signed-off-by: Ulincsys <28362836a@gmail.com>

Signed-off-by: Ulincsys <ulincsys@gmail.com>

scripts/control/restart.py

+if signal.getsignal(signal.SIGHUP) != signal.SIG_DFL:
+    cmd = "nohup " + cmd
+
+Popen(cmd, shell=True)


augur/api/routes/admin.py

+from ..server import app
+import sqlalchemy as s
+import json
+from subprocess import run, PIPE, Popen


augur/api/routes/admin.py

+@app.route(f"/{AUGUR_API_VERSION}/admin/shutdown")
+@admin_required
+def shutdown_system():
+    run("augur backend stop-collection-blocking".split(), stdin=PIPE, stdout=PIPE, stderr=PIPE)


augur/api/routes/admin.py

+@admin_required
+def shutdown_system():
+    run("augur backend stop-collection-blocking".split(), stdin=PIPE, stdout=PIPE, stderr=PIPE)
+    Popen("augur backend stop", shell=True, stdin=PIPE, stdout=PIPE, stderr=PIPE)


augur/api/routes/admin.py

+@admin_required
+def shutdown_system():
+    run("augur backend stop-collection-blocking".split(), stdin=PIPE, stdout=PIPE, stderr=PIPE)
+    Popen("augur backend stop", shell=True, stdin=PIPE, stdout=PIPE, stderr=PIPE)


scripts/control/restart.py

@@ -0,0 +1,29 @@
+from subprocess import run, PIPE, Popen


scripts/control/restart.py

+# Ignore SIGTERM from parent process (since we're terminating our parent)
+signal.signal(signal.SIGTERM, lambda signum, frame: None)
+
+run("augur backend stop-collection-blocking", shell=True, stderr=PIPE, stdout=PIPE, stdin=PIPE)


scripts/control/restart.py

+# Ignore SIGTERM from parent process (since we're terminating our parent)
+signal.signal(signal.SIGTERM, lambda signum, frame: None)
+
+run("augur backend stop-collection-blocking", shell=True, stderr=PIPE, stdout=PIPE, stdin=PIPE)


scripts/control/restart.py

+signal.signal(signal.SIGTERM, lambda signum, frame: None)
+
+run("augur backend stop-collection-blocking", shell=True, stderr=PIPE, stdout=PIPE, stdin=PIPE)
+Popen("augur backend stop", shell=True, stderr=PIPE, stdout=PIPE, stdin=PIPE).wait()


scripts/control/restart.py

+signal.signal(signal.SIGTERM, lambda signum, frame: None)
+
+run("augur backend stop-collection-blocking", shell=True, stderr=PIPE, stdout=PIPE, stdin=PIPE)
+Popen("augur backend stop", shell=True, stderr=PIPE, stdout=PIPE, stdin=PIPE).wait()


github-actions · 2026-02-25T01:18:04Z

augur/api/util.py

 import beaker

-from flask import request, jsonify, current_app
+from flask import request, jsonify, current_app, abort


[pylint] _{reported by reviewdog 🐶}
W0611: Unused current_app imported from flask (unused-import)

github-actions · 2026-02-25T01:18:04Z

augur/api/view/augur_view.py

@@ -38,6 +40,13 @@ def unsupported_method(error):

    return render_message("405 - Method not supported", "The resource you are trying to access does not support the request method used"), 405


[pylint] _{reported by reviewdog 🐶}
E0602: Undefined variable 'render_message' (undefined-variable)

github-actions · 2026-02-25T01:18:05Z

augur/api/view/augur_view.py

+    if AUGUR_API_VERSION in str(request.url_rule):
+        return jsonify({"status": "Forbidden"}), 403
+
+    return render_message("403 - Forbidden", "You do not have permission to view this page"), 403


[pylint] _{reported by reviewdog 🐶}
E0602: Undefined variable 'render_message' (undefined-variable)

github-actions · 2026-02-25T01:18:05Z

augur/api/view/augur_view.py

+        raise e

-    return render_message("500 - Internal Server Error", "An error occurred while trying to service your request. Please try again, and if the issue persists, please file a GitHub issue with the below error message:", error=stacktrace), 500
+    return render_message("500 - Internal Server Error", """An error occurred while trying to service your request.


[pylint] _{reported by reviewdog 🐶}
E0602: Undefined variable 'render_message' (undefined-variable)

github-actions · 2026-02-25T01:18:05Z

augur/api/view/augur_view.py

@@ -98,19 +120,16 @@ def load_user(user_id):
 @login_manager.request_loader
 def load_user_request(request):


[pylint] _{reported by reviewdog 🐶}
W0621: Redefining name 'request' from outer scope (line 1) (redefined-outer-name)

github-actions · 2026-02-25T01:18:05Z

augur/api/view/augur_view.py

 from .init import logger
 from .url_converters import *

+from functools import wraps


[pylint] _{reported by reviewdog 🐶}
W0611: Unused wraps imported from functools (unused-import)

github-actions · 2026-02-25T01:18:05Z

augur/api/view/routes.py

@@ -112,6 +119,10 @@ def repo_card_view():
 @app.route('/collection/status')
 def status_view():
    return render_module("status", title="Status")


[pylint] _{reported by reviewdog 🐶}
E0602: Undefined variable 'render_module' (undefined-variable)

github-actions · 2026-02-25T01:18:05Z

augur/api/view/routes.py

+
+@app.route('/connection_status')
+def server_ping_frontend():
+    return render_module("ping")


[pylint] _{reported by reviewdog 🐶}
E0602: Undefined variable 'render_module' (undefined-variable)

github-actions · 2026-02-25T01:18:05Z

augur/api/view/routes.py

@@ -318,6 +329,7 @@ def user_group_view(group = None):
    return render_module("user-group-repos-table", title="Repos", repos=data, query_key=query, activePage=params["page"], pages=page_count, offset=pagination_offset, PS="user_group_view", reverse = rev, sorting = params.get("sort"), group=group)


[pylint] _{reported by reviewdog 🐶}
E0602: Undefined variable 'render_module' (undefined-variable)

github-actions · 2026-02-25T01:18:05Z

augur/api/view/routes.py

-    backend_config = requestJson("config/get", False)
+    backend_config = AugurConfig(logger, db_session).load_config()
+
+    with get_session() as session:


[pylint] _{reported by reviewdog 🐶}
W0621: Redefining name 'session' from outer scope (line 8) (redefined-outer-name)

shlokgilda · 2026-03-04T15:37:42Z

augur/api/routes/admin.py

+
+logger = AugurLogger("augur").get_logger()
+
+@app.route(f"/{AUGUR_API_VERSION}/admin/shutdown")


Defaults to GET requests. Shouldn't this be POST only? Would prevent CSRF.

shlokgilda · 2026-03-04T15:38:12Z

augur/api/routes/admin.py

+    return jsonify({"status": "shutdown"})
+
+@app.route(f"/{AUGUR_API_VERSION}/admin/restart")
+@admin_required


Same as admin/shudown. I think this should also be POST only.

shlokgilda · 2026-03-04T15:39:09Z

augur/api/routes/admin.py

+@app.route(f"/{AUGUR_API_VERSION}/admin/restart")
+@admin_required
+def restart_system():
+    Popen("python scripts/control/restart.py", shell=True)


Can we use absolute path derived from __file__ or the project root instead of relative path?

also is this script going to work for docker installs?

shlokgilda · 2026-03-04T15:39:59Z

augur/api/routes/config.py

-
-    return response, 426
-
 @app.route(f"/{AUGUR_API_VERSION}/config/get", methods=['GET', 'POST'])


Why are we allowing POST here?

shlokgilda · 2026-03-04T15:40:30Z

augur/api/routes/config.py


    return jsonify(config_dict), 200

+@app.route(f"/{AUGUR_API_VERSION}/config/set", methods=['GET', 'POST'])


Similar to above. Config mutations via GET are a CSRF risk and leak values into server logs, browser history, and referer headers. This should be POST-only with a JSON body.

shlokgilda · 2026-03-04T15:41:31Z

augur/api/routes/config.py

+
+    return jsonify({"status": "success"})

 @app.route(f"/{AUGUR_API_VERSION}/config/update", methods=['POST'])


update_config is missing @admin_required. The new set_config_item above it has admin protection, but this existing endpoint that can overwrite the entire config is unprotected. Should be:

Suggested change

@app.route(f"/{AUGUR_API_VERSION}/config/update", methods=['POST'])

@app.route(f"/{AUGUR_API_VERSION}/config/update", methods=['POST'])

@ssl_required

@admin_required

def update_config():

shlokgilda · 2026-03-04T15:44:05Z

augur/api/util.py

+def admin_required(func):
+    @login_required
+    @wraps(func)
+    def inner_function(*args, **kwargs):
+        if current_user.admin:
+            return func(*args, **kwargs)
+        else:
+            abort(403)
+    return inner_function


The admin_required decorator has a subtle ordering issue. @login_required is applied to inner_function after @wraps(func), but login_required returns its own wrapper that doesn't preserve the metadata set by @wraps. This means the final returned function loses func's __name__ and __module__. Maybe we can use this approach:

Suggested change

def admin_required(func):

@login_required

@wraps(func)

def inner_function(*args, **kwargs):

if current_user.admin:

return func(*args, **kwargs)

else:

abort(403)

return inner_function

def admin_required(func):

@wraps(func)

def inner_function(*args, **kwargs):

if not current_user.is_authenticated:

return current_app.login_manager.unauthorized()

if current_user.admin:

return func(*args, **kwargs)

else:

abort(403)

return inner_function

shlokgilda · 2026-03-04T15:44:52Z

augur/api/view/augur_view.py

        errout.close()
    except Exception as e:
        logger.error(e)
+        raise e


raise e inside the 500 error handler will crash the handler itself, meaning the user never sees the friendly error page. Is that the intended idea?

shlokgilda · 2026-03-04T15:45:48Z

augur/api/view/routes.py

-    backend_config = requestJson("config/get", False)
+    backend_config = AugurConfig(logger, db_session).load_config()
+
+    with get_session() as session:


session here shadows Flask's session import at the top of the file. Not a bug right now but could cause confusion. Consider db_session or db_sess instead?

shlokgilda · 2026-03-04T15:48:00Z

augur/templates/admin-dashboard.j2

The IDs stats-section is reused on three different <h1> elements (Stats, User List, Config). Should be stats-section, user-section, and config-section to avoid issues down the line?

shlokgilda · 2026-03-04T15:48:46Z

augur/templates/admin-dashboard.j2

The fetch() calls for restart/shutdown don't specify { method: 'POST' }. They default to GET. If the backend endpoints get fixed to POST-only (as suggested above), these need updating too:

fetch(url, { method: 'POST' }).then(response => { ... });

MoralCode · 2026-03-04T23:14:30Z

@shlokgilda some context: i think the point of this PR is mainly to bring the admin page back (it used to be merged but somehow got unmerged)

definitely agree with a lot of the feedback though

im very hesitant about including "start and stop your instance" controls in our mixed manual/docker setup environment

sgoggins

@Ulincsys : Sorry I missed this earlier in the stack of PRs. Since all of this is really only code that Admin touches, or affects admin, and I don't see any of the general API changes as problematic, LGTM.

MoralCode · 2026-03-16T12:45:20Z

As discussed in the March 10 maintainers meeting:

Most of these API endpoints, especially for restarting the Instance, assume a non-docker install. Thus this restarting only works on bare metal
This also relies on the jumpstart part if the code still existing (consider removing if exists as its only useful outside docker)

Many of these endpoints are likely disabled anyway and Augur’s core functionality has changed since this was merged

Id like to avoid merging endpoints that are disabled and dont have a future so we dont need a followup PR to remove them later

sgoggins · 2026-03-16T14:21:41Z

As discussed in the March 10 maintainers meeting:

Most of these API endpoints, especially for restarting the Instance, assume a non-docker install. Thus this restarting only works on bare metal This also relies on the jumpstart part if the code still existing (consider removing if exists as its only useful outside docker)

Many of these endpoints are likely disabled anyway and Augur’s core functionality has changed since this was merged

Id like to avoid merging endpoints that are disabled and dont have a future so we dont need a followup PR to remove them later

I will wait for @Ulincsys to address these points. Have we verified the restart does not work on Docker? I may have missed that discussion point at the last meeting.

Ulincsys · 2026-03-16T14:40:28Z

@sgoggins I'm planning to address the comments on this tonight after I get home.

We did discuss the restart endpoints during the last meeting. They make the assumption that they are not running in Docker, and so should are not suitable for attempting a restart from within Docker

MoralCode · 2026-03-16T17:53:03Z

I see potentially two forward paths:

if jumpstart is still present in the code and we intend to keep it, then we can potentially set these routes up to only be present on the wbe server/in the admin UI when we are not running in docker.
if jumpstart isnt present/these routes arent enabled anyway, we should remove them and their UI elements since they wont be functional and wont work.

It seems like the benefit of this UI was for admin convenience when augur was not yet dockerized and startup/shutdown was a special sequence of commands that needed remembering/referring to. with docker, it can be as simple as running docker compose stop from the same folder as augurs containerfile, or docker stop <one or more container names> to stop pieces of augur.

I worry that, if we have endpoints that allow instances to be restarted in the UI, that could present a much larger DoS attack surface, or general user inconvenience in multi-admin/multi-tenancy scenarios, than the convenience it provides.

I can see a benefit to controlling augur tasks within the admin dashboard, but im not sure we need shutdown and restart endpoints

MoralCode · 2026-03-16T20:04:15Z

Jumpstart does appear to still be in the repo. last touched 2 years ago.

Im very tempted to exclude it from the docker builds. maybe we can have the code check if jumpstart is available before trying to use it and make these endpoints no-ops on docker?

Ulincsys and others added 22 commits March 20, 2023 18:39

(WIP) Re-enable admin dashboard

6597b38

Add @requires_admin decorator Add clarity to backend start error status Signed-off-by: Ulincsys <ulincsys@gmail.com>

Merge branch 'dev' into admin-changes

3ebbd22

Merge branch 'dev' into admin-changes

b467bdf

Merge branch 'dev' into admin-changes

8c35bab

Merge branch 'dev' into admin-changes

c6b0098

Merge branch 'dev' into admin-changes

d65595e

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Clean up after merge

d9de9f5

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Add more detail to 500 page report

5eae7da

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Fix missing import

c8b5853

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Merge branch 'dev' into admin-changes

985f1a2

Signed-off-by: Ulincsys <ulincsys@gmail.com>

merge dev into admin-changes

fc0a25a

Signed-off-by: Ulincsys <ulincsys@gmail.com>

implement config updating and user table view

0bb452b

Signed-off-by: Ulincsys <ulincsys@gmail.com>

add debug log

1cc5e7c

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Merge branch 'backend-detect-gunicorn-up' into admin-changes

7356865

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Update config modification logic

1755377

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Merge branch 'dev' into admin-changes

3995a94

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Implement remote restart and shutdown

1e7d9c4

Signed-off-by: Ulincsys <ulincsys@gmail.com>

further work needed in CLI

40658f5

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Merge branch 'dev' into admin-changes

a892fe6

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Remove restart/stop functionality for now

9e6b2bd

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Merge branch 'main' into admin-changes

c8d3eb5

Signed-off-by: Ulincsys <ulincsys@gmail.com>

Ulincsys requested a review from sgoggins as a code owner February 25, 2026 01:17

github-advanced-security bot found potential problems Feb 25, 2026

View reviewed changes

github-actions bot reviewed Feb 25, 2026

View reviewed changes

shlokgilda reviewed Mar 4, 2026

View reviewed changes

sgoggins approved these changes Mar 12, 2026

View reviewed changes

		@@ -38,6 +40,13 @@ def unsupported_method(error):

		return render_message("405 - Method not supported", "The resource you are trying to access does not support the request method used"), 405

		@@ -98,19 +120,16 @@ def load_user(user_id):
		@login_manager.request_loader
		def load_user_request(request):

		@@ -318,6 +329,7 @@ def user_group_view(group = None):
		return render_module("user-group-repos-table", title="Repos", repos=data, query_key=query, activePage=params["page"], pages=page_count, offset=pagination_offset, PS="user_group_view", reverse = rev, sorting = params.get("sort"), group=group)


		logger = AugurLogger("augur").get_logger()

		@app.route(f"/{AUGUR_API_VERSION}/admin/shutdown")


		return response, 426

		@app.route(f"/{AUGUR_API_VERSION}/config/get", methods=['GET', 'POST'])


		return jsonify(config_dict), 200

		@app.route(f"/{AUGUR_API_VERSION}/config/set", methods=['GET', 'POST'])


		return jsonify({"status": "success"})

		@app.route(f"/{AUGUR_API_VERSION}/config/update", methods=['POST'])

Conversation

Ulincsys commented Feb 25, 2026

Uh oh!

Check failure

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MoralCode commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sgoggins left a comment

Choose a reason for hiding this comment

Uh oh!

MoralCode commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sgoggins commented Mar 16, 2026

Uh oh!

Ulincsys commented Mar 16, 2026

Uh oh!

MoralCode commented Mar 4, 2026 •

edited

Loading

MoralCode commented Mar 16, 2026 •

edited

Loading