Update or Remove the Resource

New versions of the resource are released from time to time. Updating means downloading the new version from the Cfx.re portal, replacing the monoadmin folder and restarting the resource. Your link, your settings and your bans all stay, because none of them live in that folder. What changed in a version is listed in the changelog. This page also covers removing MonoAdmin from a server completely, in the right order.

Check Which Version You Run

You can see the version in four places:

• Console: monoadmin status starts with MonoAdmin v<version>. When a newer one exists, the next line starts with Update available: v<latest>.
• Console warning: when the server links up, and every hour after that until you update, it logs a yellow warning: MonoAdmin v<latest> is available (this server runs v<current>). Update the resource: <address>, where the address is your Granted Assets on portal.cfx.re.
• Dashboard: a banner reads “A newer MonoAdmin resource is available” with a Get the Update button.
• Settings > Server Link: Resource version shows Up to date or Update available, with Get the Update.

Update the Resource

1. Download the new version from portal.cfx.re. Get the Update (Settings > Server Link, or the dashboard banner) opens MonoAdmin in your Granted Assets on the portal. Download it there, signed in with the Cfx.re account that claimed the package. A new version does not reach your server by itself, so you download it again each time, and you get the latest full release.

2. Replace the contents of resources/monoadmin/ with the new files. Delete the old files first so none are left behind, then copy in everything from the new download, including the hidden .fxap file, and keep the folder’s name as it was (monoadmin, unless you chose another). If you upload from another machine, use SFTP or FTP in binary mode and send the whole folder.

3. Load the new files. In the server console, run:

   refresh
   restart monoadmin

   Or restart the whole server.

4. Run monoadmin status and check the version on the first line. In the panel, Resource version should read Up to date.

You do not need a new pairing code. The resource reconnects by itself from the link stored on the server, and the stored link is kept as long as the folder keeps its name.

What to Expect

• While the resource restarts, the panel shows the server as offline for a moment and comes back by itself.
• Bans, mutes and community service keep working. They are held in the server’s own storage and loaded before the first player can join.
• Staff may need to reopen the in-game menu afterwards.
• It is a good idea to do it at a quiet time, as with any resource restart.

When Your Version Is Too Old

MonoAdmin refuses connections from resource versions that are older than the minimum it supports. The server then shows Last failure: resource version no longer supported - update in monoadmin status and tries again every five minutes. Update the resource and restart it, and it connects at once.

Remove MonoAdmin From a Server

Take the pieces away in this order, so nothing is left calling a resource that no longer exists.

1. Remove references from other resources. If you added shared_script '@monoadmin/logging.lua' to other resources’ manifests, take those lines out. If a script calls exports.monoadmin:createPunishment or exports.monoadmin:logCommand, remove or guard those calls. See Scripts and Exports.
2. Unlink in the panel. Open Settings > Server Link and choose Unlink Server. The server is disconnected right away and its key stops working. Players, punishments and logs are kept.
3. Unlink on the server. In the server console, run monoadmin unlink. It deletes the stored credential and prints Unlinked from project My Server. The stored credential was deleted. This step matters because monoadmin unlink changes only the server. The panel would still list the server as Linked, currently offline if you skipped step 2.
4. Stop and remove the resource. Run stop monoadmin, delete the ensure monoadmin line from server.cfg, and delete the monoadmin folder. If you gave the folder another name, use that name in all three.

What Stays Behind

• On your server, the cached punishments (bans, mutes and community service orders) remain in the server’s key-value storage. The settings last received from the project do not, because monoadmin unlink in step 3 deletes them. The cached punishments do nothing without the resource. If you install MonoAdmin again and link the same project, they are reused and refreshed. If you link a different project, they are discarded.
• In MonoAdmin, the project, its players, punishments, reports and logs stay. What you can see is limited by your plan’s history, as described in Data, Privacy and Retention.
• A subscription is not cancelled for you. If the project has a paid subscription, cancel it from your Tebex receipt. See Paying and Renewing.

Delete the Project Itself

If you want the project and its data gone, the owner can delete it under Settings > Delete Project. This is permanent and cannot be undone.

1. Choose Email Me the Code. You may be asked to confirm it is you first.
2. Enter the 6-digit code from the email. It works for 15 minutes.
3. Choose Delete Project Forever.

Deleting removes all of the project’s players, punishments, reports, logs, roles and members for good, for every member. The linked server stops working with MonoAdmin. Unlink and remove the resource first, as above.

Move MonoAdmin to Another Server or Machine

To run the same project from a new machine, install the resource there and link it with a new pairing code. You do not need to unlink the old one first: when the new server links, the old server’s link stops working. Do not copy the old server’s stored data across to the new machine, because it holds the old link. See Link Your Server.

Troubleshooting

If an update does not take, the link does not come back or files seem to be missing, see Troubleshooting.