restauth-service may be used to manage services that connect to RestAuth. A service is a system that wants to use RestAuth to store users, preferences and groups.
RestAuth stores a name (which may not include a ‘:’) and a password that identify the service. A service additionally has zero or more IPv4 or IPv6 addresses associated with it, a service can only authenticate from the given adresses.
restauth-service [-h] {add,ls,rm,view,set-hosts,set-password} ...
Use one of the commands (either add, view, ls, set-hosts, set-password or rm) to perform the respective operation. Each command usually requires more arguments to it, see the respective section for arguments (and possible options) for each command.
To get an authoritative list of available commands, use:
restauth-service --help
If you want more information on a specific comannd, do:
restauth-service command --help
... or see the Available commands section below.
The following subsections never document the ‘-h’ parameter for clarity.
Add a new service.
The password to use.
Generate a password and print it to stdout.
The name of the service.
A host that the service is able to connect from. You can name multiple hosts as additional positional arguments. If ommitted, this service cannot be used from anywhere.
Completely remove a service. This will also remove any groups associated with that service.
The name of the service.
Set hosts that a service can connect from.
The name of the service.
A host that the service is able to connect from. You can name multiple hosts as additional positional arguments. If ommitted, this service cannot be used from anywhere.
Set the password for a service.
The password to use.
Generate a password and print it to stdout.
The name of the service.
View details of a service.
The name of the service.
The path to the Django settings module. If not set, RestAuth.settings is used, which should be fine in most cases. For more information, please read the Django documentation.
A semi-colon (‘;’) seperated list of additional directories to search for python modules. The RestAuth installation must be in the module search path for any commands to work. For more information, please read the official python documentation.