This guide provides basic management, configuration and troubleshooting tips for mudpy administrators.
Either create an account named admin or modify the main
configuration file (for example,
etc/mudpy.yaml) and change
.mudpy.limit.admins list to include the name of your initial
admin user. Once you have at least one administrative user, that
user can so something like set account.someuser
administrator True to elevate another account’s access. It’s
probably best to empty or remove the
from the configuration before making the service publicly
While the service isn’t running you can also edit the accounts.yaml
data/accounts.yaml unless you’ve changed the
default data path) and add a line like
account.someuser.administrator: true for any already existing
account in that file. In future, a separate system command-line
utility may be provided to make pre-seeding administrator accounts
possible at time of installation so that the service doesn’t need to
be started with an initially insecure configuration.
Once you’ve created and awakened an avatar for an an
administrator, you can use the interactive
command-line interface to create or destroy elements and set or
delete facets on them. A set of sample elements are available in the
source tree and included by default from the sample configuration
file (specified in its
_load list). You can also just edit those
files with a text editor or create a new directory with your own
YAML file in it to load instead.
See the built-in help as an administrator for the create, destroy, set and delete commands. For example, you can set an arbitrary value on a facet of any element like:
set account.someuser myperm True
This would add or update a myperm facet to the account element for the someuser user to have the value True.
The administrative show command provides a number of useful inspection tools. Here’s an example testing with the evaluate debug command from an active session with a couple of avatars awake, comparing with the output from related show group and show element invocations:
> show group actor These are the elements in the "actor" group: actor.avatar_admin_0 actor.avatar_luser0_0 > evaluate actor.universe.groups['actor'].keys() dict_keys(['avatar_admin_0', 'avatar_luser0_0']) > show element actor.avatar_luser0_0 These are the properties of the "actor.avatar_luser0_0" element (in "/home/fungi/src/mudpy.org/mudpy/data/actor.yaml"): gender: female inherit: ['archetype.avatar', 'archetype.actor'] location: area.0,0,0 name: Keyo > evaluate actor.universe.contents['actor.avatar_luser0_0'].get('name') 'Keyo'
Note that for safety the evaluate executes within the context of
a command handler with limited Python
mudpy library package, and the active
and also blocks evaluation of any statement containing double-underscores
__) as well as
lambda functions. For admins to gain access
to unsafe debugging commands, the
.mudpy.limit.debug option must be
enabled in configuration first and the service reloaded or restarted. It
should still be considered unsafe, since the engine’s file handling
functions could easily alter accessible files or expressions like
9**9**9 could be used to hang the service for indeterminate periods.