Apache Casbin Gateway
5. Operations

5.5 Updating, stopping and removing

The commands

CommandWhat it does
casbin-gateway startStarts the server in the background
casbin-gateway stopStops it
casbin-gateway statusSays whether it is running, and where
casbin-gatewayRuns it in the foreground, stopped with Ctrl-C
casbin-gateway uninstallPuts back everything Gateway wrote outside its own directory

All of them work from any directory: the command is a wrapper that always starts Gateway in its install directory, where its data lives.

In the background, console output goes to logs/casbin-gateway.out.

Updating

The version Gateway is running sits in the top-right corner, with the date it was built, and says New when the published build is a later one.

Open it and press Update now: Gateway downloads the build for this machine, checks that it runs, puts it in place of itself and restarts into it. The page reloads on the new version when it comes back.

Nothing else has to be touched — the data, the settings and the casbin-gateway command all stay where they are.

Gateway installed some other way, or in a directory it cannot write to, says so and shows the install command to run by hand instead. Running the install command again is always a valid upgrade; your database and settings are untouched either way.

Removing it

Run casbin-gateway uninstall first.

Deleting the directory is the part you can do yourself. What that cannot undo is everything Gateway wrote outside it:

  • the monitoring hooks in every agent's own configuration,
  • the provider each agent was pointed at,
  • the login entry,
  • the desktop entries,
  • and the ccswitch:// scheme registration,

all of which would otherwise be left naming a program that is no longer there.

uninstall puts all of that back, then names the two things to delete by hand:

PlatformDelete
Linux, macOS~/.local/share/casbin-gateway and ~/.local/bin/casbin-gateway
Windows%LOCALAPPDATA%\casbin-gateway and its PATH entry

The agents themselves, their sign-ins and their history are left exactly as they were.

Next: 6.1 Frequently asked questions.

Edit on GitHub
Apache Incubator

Apache Casbin (Incubating) is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright © 2026 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.

Apache, Apache Casbin, the names of Apache projects, and the feather logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and/or other countries. All other marks mentioned may be trademarks or registered trademarks of their respective owners.

On this page